To read the Code of Conduct please go here
To read the License please go here
To read the Contributing guidelines please go here
To report a bug go here
To request for a feature please go here
This template aims to provide a boilerplate ready REST API Server using Flask.
The server is orchestrated through a Dockerfile.
Dependencies of the server are defined in Pipfile.
Mostly if you would be using docker, dependency management would be taken care of.
For pipeline and providing Continuous Integration along with Continuous Delievery, the pipeline is running in GitLab CI/CD. Following steps are present.
- test In this section, first the unit tests are run followed by functional tests.
- build In this section, docker image is built and pushed to the container registry at gitlab, to see whether the docker container can be built.
If the branch that is currently running is master then the last deploy stage also executes
- deploy In this section, the code is deployed to heroku.
- For Visual Studio Code
If you are using Visual Studio Code you can directly launch the container by the following.
There is a .devcontainer/devcontainer.json file provided, use this to open the folder in a container.
- For Else
- Make sure your
dockerdemon is up. - Build the docker image.
$ docker-compose build - Start the docker container.
$ docker-compose up --build --detach - For running tests run the following command
$ docker-compose exec users pipenv run pytest - For linting your code run
$ pipenv run black --config pyproject.toml app/**/*.py - For creating a new database run
$ docker-compose exec users pipenv run python manage.py init_db - For seeding a new database run
$ docker-compose exec users pipenv run python manage.py seed_db
For dev environment the dependency management is done by pipenv, so prefix all commands with pipenv run
In case of any issues reach out to onlinejudge95