2025-02-27 18:56:07 +07:00
|
|
|
---
|
|
|
|
show-content: true
|
|
|
|
---
|
2022-12-01 15:24:33 +07:00
|
|
|
|
2025-02-27 18:56:07 +07:00
|
|
|
# Discover the web framework
|
2022-12-01 15:24:33 +07:00
|
|
|
|
2025-02-27 18:56:07 +07:00
|
|
|
```{toctree}
|
|
|
|
:glob: true
|
|
|
|
:titlesonly: true
|
2022-12-01 15:24:33 +07:00
|
|
|
|
2025-02-27 18:56:07 +07:00
|
|
|
discover_js_framework/*
|
|
|
|
```
|
2022-12-01 15:24:33 +07:00
|
|
|
|
2024-04-09 16:54:08 +07:00
|
|
|
This two parts tutorial is designed to introduce you to the basics of the web framework. Whether
|
2023-04-24 17:37:04 +07:00
|
|
|
you are new to the framework or have some prior experience, this tutorial will provide you with a
|
2024-04-09 16:54:08 +07:00
|
|
|
solid foundation for using the web framework in your projects.
|
2022-12-01 15:24:33 +07:00
|
|
|
|
2023-04-30 16:42:18 +07:00
|
|
|
The first part covers the basics of Owl components, which
|
2024-04-09 16:54:08 +07:00
|
|
|
are a key part of the web framework. Owl components are reusable UI components that can be used
|
2023-04-24 17:37:04 +07:00
|
|
|
to build complex web interfaces quickly and efficiently. We will explore how to create and use Owl
|
2023-04-30 16:42:18 +07:00
|
|
|
components in Odoo. Then, in the second part of this tutorial, we focus on creating a dashboard using various
|
|
|
|
features of Odoo. Dashboards are an essential part of any web application, and provide a nice starting
|
|
|
|
point to use and interact with the Odoo codebase.
|
2022-12-01 15:24:33 +07:00
|
|
|
|
2023-04-24 17:37:04 +07:00
|
|
|
This tutorial assumes that you have some basic knowledge of development with Odoo in general
|
|
|
|
(models, controllers, QWeb, ...). If you are new to Odoo, we recommend that you start with the
|
2025-02-27 18:56:07 +07:00
|
|
|
{doc}`/developer/tutorials/server_framework_101` tutorial before proceeding with this one.
|
2022-12-01 15:24:33 +07:00
|
|
|
|
2025-02-27 18:56:07 +07:00
|
|
|
:::{note}
|
|
|
|
Each chapter of this tutorial is an independant project. If you feel comfortable with Owl, you can
|
|
|
|
start directly with chapter 2.
|
|
|
|
:::
|
2023-04-30 16:42:18 +07:00
|
|
|
|
2025-02-27 18:56:07 +07:00
|
|
|
(tutorials-discover-js-framework-setup)=
|
2023-04-30 16:42:18 +07:00
|
|
|
|
2025-02-27 18:56:07 +07:00
|
|
|
## Setup
|
2022-12-01 15:24:33 +07:00
|
|
|
|
2025-02-27 18:56:07 +07:00
|
|
|
1. Clone the [official Odoo tutorials repository](https://github.com/odoo/tutorials) and switch to
|
2023-04-03 21:22:08 +07:00
|
|
|
the branch `{CURRENT_MAJOR_BRANCH}`.
|
2025-02-27 18:56:07 +07:00
|
|
|
2. Add the cloned repository to your {option}`--addons-path <odoo-bin --addons-path>`.
|
|
|
|
3. Start a new Odoo database and install the modules `awesome_owl` (for chapter 1) and `awesome_dashboard`
|
2023-04-30 16:42:18 +07:00
|
|
|
(for chapter 2).
|
2022-12-01 15:24:33 +07:00
|
|
|
|
2025-02-27 18:56:07 +07:00
|
|
|
## Content
|
|
|
|
|
|
|
|
- {doc}`discover_js_framework/01_owl_components`
|
|
|
|
- {doc}`discover_js_framework/02_build_a_dashboard`
|
2022-12-01 15:24:33 +07:00
|
|
|
|