This guide should be used for local setup and testing only purposes. Don't use any credentials you might bump into in files like
docker-compose.yml
in production.
- Based on
.env.template
, create your own.env
file and fill in all the possible entries.APP_CONFIG__DB__URL
is mandatory to start the project and apply initial migrations. - Run
docker-compose up
command and make every container is up-and-running - Apply the latest migrations you have in
alembic/versions
folder. For this usealembic upgrade head
command. - Follow
localhost:8000/docs
to have a view of APIs available to do further dev testing
- Setup the project locally and make sure it's running without any issues
- Configure and implement logging functionality so that every request is logged into console and separate file named
pet.log
. This logging data should contain:- Request URL
- Request method
- Status code
- Total time required to complete the request
- Additionally you could implement the same logging functionality, but using decorator approach, so that codebase is split to corresponding modules and looks concise.