dcwiz-app-template

Cookiecutter Template of DCWiz Applications

Usage

Run the following command and follow the prompts to generate a new project.

$ cookiecutter gh:cap-dcwiz/dcwiz-app-template

Development

1. The database models should be placed in the {project_slug}/db/models folder.
2. The database operations should be placed in the {project_slug}/db/data folder.
3. The API endpoints should be placed in the {project_slug}/api folder.
4. Each subfolder in the {project_slug}/api folder will be a independent API router.
5. Put the API schemas in the {project_slug}/api/schemas folder.
6. Put the API endpoints in the {project_slug}/api/router folder.
7. The endpoints under "default" router will be mounted to the root path.
8. The endpoints under other routers will be mounted to the path of the router.
9. After deployment, by default, the API will be available at http://<host>:<port>/<APP_PATH>, which is set during the initialization of the project. If you want to change the path, modify the docker compose file.

How to setup the development environment

1. Install poetry.

2. Install poetry environment and dependencies.

$ poetry install

3. If database is needed, create the database and user.

$ docker compose up -d

Note: the docker-compose.yaml file will be created only when the database is needed.

4. Create a .env file

$ cp export/env.dev .env

5. Run the following command to start the service.

$ poetry run <app name>

Note: Check the pyproject.toml file to see the name of the app. By default, it is the project folder name but replacing "_" with "-".

6. Check the API documentation at http://localhost:8000/docs. By default, there should be a health check endpoint.

Database init and migration

If the app uses database, run the following command to init, migrate or upgrade tables.

DCWIZ_APP_CONFIG=config/config.toml poetry run alembic revision --autogenerate
DCWIZ_APP_CONFIG=config/config.toml poetry run alembic upgrade head