{"id":22307916,"url":"https://github.com/akretion/docky-odoo-template","last_synced_at":"2025-04-12T06:05:38.548Z","repository":{"id":39422221,"uuid":"147373620","full_name":"akretion/docky-odoo-template","owner":"akretion","description":"This a project template to use with docky","archived":false,"fork":false,"pushed_at":"2025-04-10T15:02:00.000Z","size":266,"stargazers_count":2,"open_issues_count":16,"forks_count":13,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-12T06:05:33.761Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akretion.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-04T16:12:22.000Z","updated_at":"2024-12-13T11:46:00.000Z","dependencies_parsed_at":"2023-11-13T09:26:19.094Z","dependency_job_id":"a8d1c232-b448-4187-9a50-f6cb0fb73f2d","html_url":"https://github.com/akretion/docky-odoo-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akretion%2Fdocky-odoo-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akretion%2Fdocky-odoo-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akretion%2Fdocky-odoo-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akretion%2Fdocky-odoo-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akretion","download_url":"https://codeload.github.com/akretion/docky-odoo-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248525144,"owners_count":21118618,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-03T20:12:32.226Z","updated_at":"2025-04-12T06:05:38.509Z","avatar_url":"https://github.com/akretion.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Basic Odoo project template used by [docky](https://github.com/akretion/docky)\n\nThis repo contains all the basic files needed to create an Odoo project from scratch using the [docky](https://github.com/akretion/docky) and [ak](https://github.com/akretion/ak) command-line tools developed by [Akretion](https://akretion.com).\n\nTo start a new Odoo project, you don't need to download this repo anymore:\n\n1. First install [docky](https://github.com/akretion/docky) (version \u003e 8.0.0), [copier](https://github.com/copier-org/copier) and [ak](https://github.com/akretion/ak)\n\nFor that we strongly recommend you to install them with [pipx](https://github.com/pypa/pipx)\n\n```\npipx install docky\npipx install copier\npipx install git+https://github.com/akretion/ak.git@master\n```\n\n2. Create the project directory from a template with `copier copy`. For instance:\n\n```\ncopier copy https://github.com/akretion/docky-odoo-template my-odoo-project\n```\n\n(you will then be asked to choose an Odoo version by copier).\n\n3. Create the \".env\" file\n\nYou can copy the \".env-sample\" to \".env\" and update enviroment variable if needed\n\n\n4. Download the Odoo source code and other external modules specified in the [spec.yaml](odoo/spec.yaml) and [odoo-spec.yaml](odoo/odoo-spec.yaml) file using `ak build` from the spec.yaml's folder\n\n\n```\ncd odoo\nak build -c odoo-spec.yaml\nak build\n```\n\n\u003e [ak](https://github.com/akretion/ak) use the [git-aggregator](https://github.com/acsone/git-aggregator) tool by [Acsone](https://www.acsone.eu/).\n\u003e More information on the [git-aggregator](https://github.com/acsone/git-aggregator) repo to understand how to fill the [spec.yaml](odoo/spec.yaml) file.\n\n\n5. Once all the code is downloaded, go back to your project's root folder and launch `docky run`\n```\ncd ..\ndocky run\n```\n\nOn the first `docky run`, docky will download the Odoo image referenced in the [DockerFile](odoo/Dockerfile) and run your different docker-compose files (basically docker-compose.yml, dev.docker-compose.yml or prod.docker-compose.yml) following the environment's variables registered in your **.env** file.\n\nTo reload the Odoo docker image or to update your docky after changing you environment variables, run `docky build`.\n\nMore information on : [docky](https://github.com/akretion/docky).\n\n\n# Bump and Migration\n\nWhen creating migration script (pre, post...) you can name the directory \"0.0.0\"\nIndeed Odoo will always run migration script with the version \"0.0.0\" so you can use this as\nthe \"current\" migration script for your PR.\nThen whenever you will run the cmd \"./bump\" it will set the right version number.\n\n\n# Spec Tips (TODO move in ak doc ?)\n\n```\nsocial:\n    modules:\n        - mail_debrand\n    src: https://github.com/OCA/social 14.0\n\nserver-auth:\n  modules:\n    - auth_oidc\n  src: https://github.com/OCA/server-auth 14.0\n\n# Recommended way: prefer short syntax without merges\n# all stable modules from main branch\nserver-tools:\n  modules:\n    - base_technical_user\n  src: https://github.com/OCA/server-tools 14.0\n\n# and an dedicated entry (dir) for each\n# pending branch in order to avoid merges.\nserver-tools-sentry:\n  modules:\n    - sentry\n  src: https://github.com/akretion/server-tools 14.0-mig-sentry-sdk\n\n# Alternative syntax\n# not recommanded\n# can also be used with multiple patch on the same module\nserver-brand:\n    modules:\n      - disable_odoo_online\n      - remove_odoo_enterprise\n    remotes:\n        oca: https://github.com/OCA/server-brand\n    #   ak: https://github.com/akretion/server-brand\n    merges:\n        - oca 14.0\n        - oca refs/pull/39/head # PR for 'remove_odoo_enterprise'\n        # - ak somebranch\n```\n\n\n# Tips for the template maintenance\n\n## pre-commit\n\nPrecommit file are extracted from the OCA project https://github.com/OCA/oca-addons-repo-template\n\nFor updating the files you need to execute the file **update_oca_file.py**.\nThen commit the updated files.\nIf files were added in the OCA, please update the script before.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakretion%2Fdocky-odoo-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakretion%2Fdocky-odoo-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakretion%2Fdocky-odoo-template/lists"}