It's responsible for managing the registration flow of beverage distributors.
Run the API:
make docker/runand access:
docs: http://localhost:5000/docs || redoc: http://localhost:5000/redoc
- - Sentry
We have also configured the / metrics route that exports metrics for prometheus.
make docker/buildmake docker/runIf you want to run / debug the site, you can use the vscode launch.json suggested by the project
make docker/lintmake docker/test-unit
make docker/test-integrationWe separate a specific document to be used in the integrations tests in a parameterized way. You can change this number in the configuration if you wish.
For the CD process, a GH workflow should be created, which is triggered by the case of a new release and thus, executes the commands to deploy the application to the respective environment.
In the deploy directory, there is a sample of Kubernetes app deployment which you can use as a template if you want and if your infrastructure is prepared for Kubernetes apps. If you choose to do so, you'll need to include a command in the CD flow to add the deployment to your cluster. Check out more information here:
If you choose to deploy this API as a lambda, you will have to use a library that envelopes the code into the lambda format (this lib Mangum might make sense) and then proceeds to the lambda deployment process usually using flow with AWS S3 and AWS SAM. If you choose to do so, you'll need to include a command in the CD flow to add the deployment to your cluster.
For the creation of the database, we recommend that you create a cloud formation template and then run it on the AWS panel to create the database. Once it's done, it will be necessary to create the API table in your bank and for that, you should use the .sql script contained in the database directory of this repository.
To update the project diagram initilize your local environment:
make local/initSo run the command:
make local/diagram