Overview

REST API for Resturant-Self-Order.

Project Setup

Follow the steps below to set up the project on your environment. If you run into any problems, feel free to leave a GitHub Issue or reach out @Hussu or @Sazid Ahmed on slack.

Activate Your Virtual Environment.

Clone the repo:

git clone https://github.com/Restaurants-Self-Order/Backend.git

Install required packages:

pip3 install -r requirements.txt

Rename the .env.example file to .env and put your email and app password to the fields to send emails.

To check styling:

flake8 --config=.flake8 config v1

API Documentation

Visit here : #83

Integration with Frontend

Visit here : #84