First of all, you need to install poetry. To do that, run
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | pythonTo get started you need Poetry's bin directory ($HOME/.poetry/bin) in your PATH
environment variable. Next time you log in this will be done
automatically.
To configure your current shell run source $HOME/.poetry/env
This project uses black as the code formatter and flake8 as the linter.
To add git-hooks on your enviroment, so you can run black and flake8 on your project for every commit, please execute pre-commit install.
Also, you need to configurate the enviroment variables accordingly. Create env file in the project's root folder and set the variables following the .env.example.
In order to have the poetry packages in a local virtual environment (in the project root directory), run:
poetry config virtualenvs.in-project true
make installIf you don't wanna a local virtual env, just run make install alone.
You can always use Docker (recommended) to get those things isolated, in a container. To create and start the container running on background, execute:
docker-compose up -dTo run the migrations, execute the command:
docker-compose exec flasky make migrateCheck the running application on your browser with the http://127.0.0.1:8000/api/v1 url.
This project uses flasgger and you can access the API documentation on http://127.0.0.1:8000/apidocs.