Maintenance-Tracker

Maintenance Tracker App is an application that provides users with the ability to reach out to operations or repairs department regarding repair or maintenance requests and monitor the status of their request.

Features

• Sign up to Maintenance Tracker
• Login to access features
• Update password
• Update profile
• Transactional Email notifications on requests(status)

User Features

• Make Request for repair or maintenance
• View all requests belonging to them
• View Details of a single request belonging to them
• Modify a pending request
• Delete a resolve or disapproved request

Admin Features

• View all requests on the system
• Approve a request
• Disapprove a request
• Resolve a request

Tools

Dev Tools

• HTML
• CSS
• JAVASCRIPT(Node.js)

Testing framework

• Mocha
• Chai
• Chai-http

Project Management

• Pivotal Tracker

Continous Integration

• Travis ci
• Coveralls

API Docs

• Apiary

Getting Started

To setup Maintenanace Tracker, these should be installed on your machine

• Node.js 6 and above
• Postman Native or Postman Chrome extension
• Postgres Database or create an Online Elephant sql database
• Git

Installation

To have a copy of Maintenance Tracker up and running on your local machine, follow these steps

• Copy the repo link https://github.com/chukwuemekachm/Maintenance-Tracker.git
• Create a folder on your machine to house Maintenanace Tracker on your machine
• Create a local sql database with Postgres or an online database with Elephant-sql or any other online Postgresql database provider.
• Obtain the database url of the database you created
• Start up command line and cd to the directory of the Folder you create for Maintenanace Tracker
• Run git init to initialize a local git repository
• Add the repo link above as the remote origin by running git remote add origin <link>
• Run git pull origin develop
• Add a .env file to project root. A sample of the .env can be found at the project root with the name .env-sample
• Provide all the informaion needed in the .env as specified on the .env-sample
• Run npm install to install app dependencies
• Run npm migrate to migrate database

Now you've successfully installed Maintenance Tracker

Running the app

To run your newly installed Maintenanace Tracker

• Run npm start

Running automated tests

To run the automated tests that comes with your newly installed Maintenanace Tracker

• Run npm test

License

This project is authored by Chima Chukwuemeka (chukwuemeka) and is licensed to use under the MIT License - see the LICENSE.md file for details