Skip to content

README.md

Latest commit

 

History

History
33 lines (27 loc) · 1.73 KB

README.md

File metadata and controls

33 lines (27 loc) · 1.73 KB

#Maintenance Tracker App

This is a web based application that allows Admin and clients to interact. Clients post their maintenance or repair requests while Admin approves or rejects them.

installation procedure.

a. Ensure you have python 3.6.2,pip, and virtualenv are installed on your local machine. b. Ensure you have Postman since it might bee needed to test the API c. Clone the project to your local machine. d. Navigate to the project folder. e. Create a virtual environment using virtualenv venv on your command line

```
export SECRET="random_key"
export APP_SETTINGS="development"
```
  1. Activate your virtual environment i.e. source venv/bin/activate.
  2. install the requirements in the environment i.e. pip install -r requirements.txt

Running the app

  1. python run.py

Working endpoints

URL Methods Description
/api/v1/register/ POST Registering a new user
/api/v1/login/ GET User login
/api/v1/requests/ POST Create a new request
/api/v1/requests/ GET Get all user requests
/api/v1/requests/<user_id> GET Get all requests for a given user
/api/v1/requests/<request_id> GET Get a request
/api/v1/requests/<request_id> PUT Edit a request