Maintenance tracker is a platform that allows users to reach out to maintenance department to request repairs/ maintenance. Users can keep track the progress of their requests via the status which may be one of Pending, Approved, Rejected, Resolved. Users should also be able to contact the service department if need be to clarify the status of thier request. Admin should be able to view all request from users and reject or approve the request. After the Operation department must have resolved a request the admin should be able to mark the request as resolved and notify the users of the update.
- Status
- Starting the application
- Testing
- Route table
- Docs and Links
- Author and Contributors
Clone the repository git clone https://github.com/tutugodfrey/maintenance-tracker.git
cd maintenance-tracker
Run npm install to install dependencies
Running npm run start:dev will start the application in development. In this case the application is being serve from the src/ files with babel-node and nodemon to watch for file changes. Before pushing to source control (github), or testing with travis ensure you
run npm run build to transpile the source file to es6 and above. Transpilation will build source files into trans/ directory for production and testing with continous integration platform.
To start the application in production mode run npm start which will serve the application from the trans/ directory
Routing table
There are two modes to run test locally, npm run test:local and npm test. npm run test:local will transpile source code to es5 from src/ to trans/ directory and then run the test which is served from the trans/ directory. npm test will run the test directly from the trans/ directory skipping the transpiling stage. You will probably want to use the latter command if no changes has been made in src/ since last transpilation, thus conserving the time use for transpiling.
NOTE: ensure you are in test environment before running test. run export NODE_ENV=test or set NODE_ENV=test depending on whether you are using bash or window cmd.
| Paths | Methods | Actions |
|---|---|---|
| / | GET | Application default route |
| /api/v1/docs | GET | Documentation |
| /api/v1/auth/signup | POST | user signup |
| /api/v1/auth/signin | POST | user signin |
| /api/v1/auth/services | GET | get info about service providers |
| /api/v1/users/requests | POST | Create a new request |
| /api/v1/users/requests | GET | get all requests |
| /api/v1/users/requests/:requestId | GET | get one request |
| /api/v1/users/requests/:requestId | PUT | update a request |
| /api/v1/users/request/:requestId | DELETE | delete a request |
| /api/v1/requests | GET | admin get all requests |
| /api/v1/requests/:requestId/disapprove | PUT | admin can disapprove a request |
| /api/v1/requests/:requestId/approve | PUT | admin can approve a request |
| /api/v1/requests/:requestId/resolve | PUT | admin can mark a request as resolve |
| /api/v1/contacts | POST | send a message |
| /api/v1/contacts | GET | get all messages |
- Tutu Godfrey[email protected]