Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 2.03 KB

README.md

File metadata and controls

66 lines (48 loc) · 2.03 KB
Raw

Build Status codecov Code style: black

Welcome

This template developed to speed up the process of development REST API with GAE and Cloud Datastore. It built on top of Flask, Flask-RESTPlus.

We have configured CI pipeline using Travis-CI with integration tests, code style check using Black, code coverage report with codecov.io

The application can be run locally or inside a Docker container.

Quick Strat

  1. Clone the repo
$ git clone https://github.com/olegnatsevsky/gae_backend_bootstrap.git
$ cd gae_backend_bootstrap
  1. Run containers
$ docker-compose up

  1. Open ping endpint http://localhost:5001/api/1/users/ping

  2. Swagger docs http://localhost:5001/api/1/docs

Testing, code style

  1. To run integration tests
$ docker-compose exec users python manage.py test
  1. To run tests with coverage
$ docker-compose exec users python manage.py test-cov
  1. To check code style with flake8
$ docker-compose exec users flake8 project
  1. To check code style with Black
$ docker-compose exec users black . --check --diff  --exclude env/

Deployment to Google App Engine

(TBD)

Learn More

(TBD)

Inspired by

This project is based on Microservices with Docker, Flask, and React I highly recommend this course it full of details, best practices and many more.

Author