example_web_app

An Example Web API project powered by Aiohttp and SQLAlchemy

Contents

• Synopsis
• Dependencies
  • Critical Backends
  • System Requirements
• Features
• API
• How To Guides
  • Setup
    • Setup on Host
  • Build
    • Build on Host
    • Build on Docker
  • Run
    • Dev Server
    • Standalone
    • Docker
  • Test
  • Package
• Additional Resources

Synopsis

bin/service {start|stop|status|restart}

Dependencies

Critical Backends

• [TODO: Add services, data stores and critical backends]

System Requirements

• Please refer to the requirements.txt file and the setup.py script for a complete, up-to date, list of application requirements
• The requirements_dev.txt file specified dependencies necessary for running the tests. See testing instructions below

Features

• [TODO: Add list of user-facing features]

API

• Swagger UI: http://0.0.0.0:9999/api/v1.0/docs
• OpenAPI Schema Definition: example_web_app/docs/swagger-v1.0.yaml

How To Guides

Setup

Setup on Host

Configure the app:

cp config/default.conf ~/.config/example_web_app.conf

Install the app:

$ make clean install

Make sure you have the database user/passwords in your ~/.pgpass file.

Build

Build on Host

$ make clean install

Build on Docker

$ make docker-build

Run

Dev Server

Development server is strictly for development purposes only. It comes with neat support for file-watching and automatic hot-reload.

$ make dev-server

Standalone

To run the application as a standalone service in the background (SysV style), run the following command. All logs are redirected to the logs/example_web_app.log file.

$ bin/service start

Docker Container

$ make docker-run

The above command assumes the docker image has been built, to make sure you have built it already, please run the following command:

$ make docker-build

Test

$ make test

Package

$ make package

The result of the command is a wheel binary under the dist/ local directory.

Additional Resources

• [TODO: Add any relevant additional resources to the project]