ah-med / MaintenanceTracker

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.

MaintenanceTracker

Maintenance Tracker App is a node/express 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.

Getting Started

To get a copy of the project for development and testing purpose

• download or clone this repository

  $ git clone https://github.com/ah-med/MaintenanceTracker.git

- Migrate to project folder
``` bash
  $ cd MaintenanceTracker 

• Install dependencies

  $ npm Install

Prerequisites

These are some of the software you will need to install on your machine

• Node.js - A back-end framework built with Javascript.
• Expressjs - A web framework for NodeJS.
• Git - A free and open source distributed version control system
• Postman - To test API endpoints
• Nodemon - Tracks changes in files during development and restart server
• Any editor of your choice.

Installing

To get the development environment running

• Install all dependencies

$ npm install 

• Start the application

 $ npm run start

Running the tests

You can also run the tests

$ npm run test

Built With

• Node.js - A back-end framework built with Javascript.
• Expressjs - A web framework for NodeJS.

Contributing

Prerequisite - A practical experience with front-end design and back-end web programming using HTML, CSS, Javascript and NodeJS/Express.

This project is written in ECMAscript6(ES6) and uses Babel to transpile down to ES5. Follow the steps below to contribute to this project

• Fork the project

  In the top-right corner of this page, click Fork.

• Clone to your computer

   $ git clone https://github.com/yourusername/MaintenanceTracker.git

• Create a Branch

   $ git branch <yourbranchname>
   $ git checkout <yourbranchname>

• Make Changes

   Feel free to make the project better

• Create a Pull Request

   Push your changes and create a pull request.

Please read CONTRIBUTING.md for details of the process for submitting pull requests to us.

Versioning

For the versions available, see the tags on this repository.

Author

• Ahmed Omosanya

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Andela Bootcamp Cycle 32
• Ibrahim Abdulazeez (LFA)