dArk-EThos / maintenance-tracker

Landing page

Maintenance Tracker Application

An application that helps users make requests for maintenance/repair services. The admin of the application receives the request and either approves or disapproves it. If the request is approved the user is notified and he/she gets the appropriate services as requested. User can also track his/her requests.

Usage

• Create an account and login

• Make a request

• Request is aprroved or disapproved

• If approved you get served

Installation

Download the project to your local computer through

• Download a zip folder of this repository
• Unzip it and navigate into the ui directory
• Open index.html in a browser (Google Chrome is preferred for better experience) 😎.

Alternatively

Run the following command

$ git clone [e-mail]:DennisWanjiru/maintenance-tracker.git

• Locate a folder named maintenance-tracker in your computer
• Open index.html in a browser (Google Chrome is preferred for better experience) 😎.

API

Documentation

Here is the API Documentations

Prerequisites

• Python 3.6
• Virtual Environment
• Flask
• Flask-RESTful

Endpoints

METHOD	ENDPOINT	DESCRIPTION
GET	/api/v1/users/requests/	Fetch all the requests resources
GET	/api/v1/users/request/int:request_id/	Fetch a single request resource
POST	/api/v1/users/requests/	Create a new request
PUT	/api/v1/users/request/int:request_id/	Update a specific request
DELETE	/api/v1/users/request/int:request_id/	Delete a specific request
POST	/api/v1/users/auth/signup/	Handle user registration
GET	/api/v1/requests/	Get all requests in the app
PUT	/api/v1/requests/string:request_id/resolve/	Resolve request
PUT	/api/v1/requests/string:request_id/reject/	Rejecte request
PUT	/api/v1/requests/string:request_id/aprove/	Approve request

Technologies & Languages

Project management (Agile) https://www.pivotaltracker.com

Version control (Git) https://git-scm.com/

SVG icons (Feathers icons) https://icomoon.io/

HTML5

CSS3

Contributing

1. Fork the repository

2. Clone the repository to your local computer

$ git clone [e-mail]:DennisWanjiru/maintenance-tracker.git

$ cd maintenance-tracker

$ git fetch --all

$ git pull --all

Authors

Dennis Wanjiru

License

MIT

Acknowledgement

Andela Bootcamp - cohort 28