Odoo Development Framework
- "Elias Braceras"
- "Horacio Montaño"
- "1.2"
RocketDoo is an automated development Framework, designed for ERP-ODOO; in all its versions and editions. This repository is a template, which allows you to create your own repository to be able to develop with comfort. In order to use it, it is important to install the framework, after creating and cloning its repository created from the template.
pip install rocketdoo
-
This development environment is intended for those developing on Linux operating systems, such as Ubuntu, Debian, etc. However, for those who prefer to develop on Windows, we suggest installing WSL2, the Windows Subsystem for Linux.
-
This version includes a CLI project launcher designed to make setting up your development project easier.
-
Docker is used to create Odoo instances, and Docker Compose is used to spin them up along with a database.
-
A set of configurations is provided for use in VSCode, including debugging and container launch configurations.
-
Gitman is used for downloading and installing external repositories.
-
Make sure you have Docker and Docker Compose installed on your computer. If not, you can follow the official Docker installation guide, Docker Installation Guide.
-
The first step is to use the HDMSOFT repository, our rocketdoo template, by creating a repository from it using the green use this template button at the top right corner.
-
Decide on a name for your development repository.
-
Once your repository is created, clone it:
git clone "your_repo_url" -
Before running the launcher, navigate to your repository directory and install the dependencies using the command:
sudo pip3 install -r requirements.txt -
To start, you must enter the subdirectory “rocketdoo” located in the root of rocketdoo; and then execute the following command:
rocketdoo -
Follow the steps provided by the launch software.
-
The second stage of the LAUNCHER offers you the option to use GITMAN for third-party repositories. If you say yes, you’ll need to answer some questions.
-
Our launcher will modify the odoo.conf file in the "addons_path" line with the new repositories.
-
Once your project is ready, you can bring up your local instance with:
docker compose up -
RocketDoo will start building the environment image and then launch the system. Once successfully completed, you can check by entering the following URL in your web browser: localhost:port
-
If your project has launched successfully, you can run the command:
```code .```
NOW YOU CAN START DEVELOPING WITH "VISUAL STUDIO CODE"!
-
We recommend using Visual Studio Code Extensions, such as Docker, Dev Container, and any others you find useful for working in VSCode.
-
If you wish to develop in the Enterprise edition, Rocketdoo will ask you, and will make the necessary configurations. However, you should ensure that you have the "enterprise" folder with all the modules and place it in the root of this project.
-
This development framework allows you to use private repositories for your developments. For this, the system will ask you if you want to use “private repositories” and if your answer is YES, it will map your local user folder “~/.ssh/” and ask you to choose which ssh key to use. Don't worry, these private keys are not saved in your repository after the commit and push; it simply stores them locally and inside the development docker container. Remember that your selected key must be previously configured with your GitHub repository. This private information is as ephemeral as your environment.
-
If you need to use third-party addons after setting up your development environment with our launcher, you’ll need to manually edit the gitman.yml file and also add lines to the odoo.conf addons_path using:
sudo nano gitman.yml
and complete each line, starting with the repository URL and version, according to your development deployment version. You’ll need to replicate the set of lines to add more third-party repositories.
If you need help, you can refer to the gitman official guide.
- In this example, you can see how to add your new module package paths.
Example:
addons_path: usr/lib/python/dist-packages/odoo/extra_addons/,usr/lib/python/dist-packages/odoo/external_addons/account-financial-tools
-
Gitman creates a folder containing all declared modules under external_addons, which can be found inside your Odoo web container at the path declared in odoo.conf.
-
All paths should be separated by a comma ","
-
Once third-party modules are declared in "gitman," you’ll need to rebuild your image, keeping the same image name as initially created, using the command:
docker build . -t my-image-name -
Then restart the Odoo service or container with the command:
docker compose restart
and once in your Odoo instance, refresh the application list in "developer" mode to see the new modules.
If you modify your gitman.yml file before building with the "build" command, it will be sufficient to see the modules without needing to restart your containers.
- For simpler third-party modules, as well as the module you’re developing, we recommend placing them in the addons folder within your working directory.
-
If you have any questions or issues with our development environment, you can contact us and submit your inquiry or support ticket by clicking on the link below.
