Skip to content

mepeltier/example-rest

 
 

Repository files navigation

Example REST Project

Prerequisites

This project is managed with Poetry.

To install poetry on your system, follow the instructions here.

Quickstart

Once you have poetry installed, use it to create a virtual environment in your project directory and install dependencies:

$ cd example-rest
$ poetry install

Then install the pre-commit hooks into your local git repository. These will be used to help ensure consistent formatting using black and flake8.

$ poetry run pre-commit install
$ poetry run pre-commit install --hook-type commit-msg

Then, execute the project with:

$ poetry run python -m example_rest

About

Simple REST Project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 66.8%
  • Shell 20.7%
  • Dockerfile 9.1%
  • JavaScript 3.4%