Service uses docker compose to deploy the application. This type of deployment was chosen to accommodate requirements for High Availability (HA). PostgreSQL is deployed using Patroni. It was chosen to imitate fail-safe mechanism to preserve all data.
Run following depending on your OS.
For Linux systems use files with "sh" postfix, like format.sh
,
for Windows use cmd-files - start.cmd
.
Preferable scripts launch sequence
- format
- start
- alembic (run only on the first launch)
- test
- stop
CAUTION!: check scripts before running them
- to format
./scripts/format.sh(.cmd)
- to start
./scripts/start.sh(.cmd)
- to apply alembic revisions
./scripts/alembic.sh(.cmd)
- to test
./scripts/tests.sh(.cmd)
- to stop
./scripts/stop.sh(.cmd)
- Swagger http://127.0.0.1:8000/docs#
- ReDoc http://127.0.0.1:8000/redoc#