/flask-restful-template

Flask REST API Template

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

FooBar App: Flask RESTful Template

Python codecov codacy travis

Initial server set-up

  1. git clone https://github.com/5hirish/flask-restful-template
  2. Install RabbiMQ
  3. Install Python3
  4. Install PostgreSQL
  5. Setup Virtual Env for Python3

Post-Installation

  1. Activate virtual environment source
  2. pip install -r requirements.txt
  3. Update .env files; refer the .env_sample file
  4. Clone unit files *.service to /etc/systemd/system
  5. Set up AWS .credentials ARN roles, set up .bash_profile variables

Monitor

  • Flask: {baseUrl}:5000
  • RabbitMQ: {baseUrl}:15672

Documentation

  • Swagger API Documentation

Tests

  • 9 unit test cases with 100% file coverage and 84% line coverage.