Skip to content

onlinejudge95/Flask-REST-Server-Template

Repository files navigation

Flask-REST-Server-Template

Build Status GitHub top language codecov Updates Python 3 GitHub code size in bytes GitHub issues GitHub pull requests GitHub GitHub last commit

Info

This is a template for spinning up a REST server in Flask for API first development. Use this repo as a template repo.

Dependencies

The server is tested in our travis account for following versions of Python

  • 3.7

The server dependencies specified in Pipfile.

Docker

The image is pushed to dockerhub {$LINK}, every push to git repository triggers a new build at the dockerhub.

  • To build the image after modifications, run
    $ docker build -t {$IMAGE}:{$TAG} .
    
  • To run the container after the image has build successfully, run
    $ docker run -it -d -p {$EXTERNAL_PORT}:8000 {$IMAGE}:{$TAG}
    

Setup

To setup the dev env use the following commands.

$ python3 -m venv env
$ source env/bin/activate
(env) $ pip install --cache-dir .pip.cache/ --progress-bar emoji --upgrade pip setuptools
(env) $ pip install --cache-dir .pip.cache/ --progress-bar emoji --requirement requirements/dev.txt
(env) $ cp .env.example .env

To setup the db use the following commands.

(env) $ python manage.py db init

To make a migration run the folowing commands

(env) $ python manage.py db migrate -m $MESSAGE
(env) $ python manage.py db upgrade

Contact

onlinejudge95