Let's begin this tutorial. You will start with cloning the repository on your local machine.
git clone [email protected]:antkahn/flask-api-starter-kit.git && cd flask-api-starter-kit
git co tutorial
Install docker and docker-compose if you don't already have them.
The API uses Docker in a dev environment.
Run your first command:
make install
What that command does is:
- Docker (through docker-compose) creates the python and the DB containers as configured in the
docker-compose.yml. - Docker will install Python vendors in the container through pip.
The vendors to install are listed in
requirements.txt.
You can now start the server :
make start
You can verify that your server is running by going on the url : http://127.0.0.1:3000/application/spec
We now have a server to work with ! Let's code !