/TripRec

Primary LanguagePythonMIT LicenseMIT

Build Status

Motivation

blueprint to implement a flask application. This application may be used to:

  • build MVC application as multipage web application
  • build API application
  • ...

Getting started

System requirements

The following requirements has to be setup on your host before running the command from this repository.

Install the python dependencies

make install_requirements_dev
make start

The latest version

You can find the latest version to ...

git clone git@github.com:FabienArcellier/blueprint-webapp-flask.git

Usage

You can run the application with the following command

make start

Usage for production

This blueprint use gunicorn as wsgi server for production configuration. The command is set in the Procfile to be available on PaaS environment as Heroku or Scalingo.

pipenv run prod

Contributing

Install development environment

Use make to instanciate a python virtual environment in ./venv3 and install the python dependencies.

make install_requirements_dev

Freeze the library requirements

If you want to freeze all the packages, use this procedure

make update

Activate the python environment

When you setup the requirements, a venv3 directory on python 3 is created. To activate the venv, you have to execute /

make activate

Run the linter and the unit tests

Before commit or send a pull request, you have to execute pylint to check the syntax of your code and run the unit tests to validate the behavior.

make lint
make tests

Contributors

  • Fabien Arcellier

License

A short snippet describing the license (MIT, Apache, etc.)