A maintenance tracker application built with graphql and Vue js
Maintenance tracker is an app that makes managing of repair/maintenance operations very easy and seamless.
With a very intuitive frontend and a robust Graphql using Apollo API, the app is very easy to use.
To use the app, register an account on the frontend and create a request.
This project is scaffolded using typescript-advanced-boilerplate maintained by the GraphQL community, with official support from the Apollo & Prisma teams and an adaptation of the vue-graphql-enterprise-boilerplate by Fran Dios. Credit to all the awesome contributors to these projects.
the app has the following features:
-
A User can:
- create an account and login.
- make maintenance/repairs requests.
- view all his/her requests.
- view details of a request.
- update a request, if it is yet to be approved.
-
An admin can:
- approve or disapprove a request.
- mark request as resolved once it is done.
- view all requests on the application.
- filter requests.
- view the details of a request.
To run the app locally, setup a local development environment. Ensure that Nodejs and PostgreSQL are installed on your machine.
- Clone the repository:
git clone https://github.com/Veraclins/graphql-vue.git. - Navigate to the project directory:
cd graphql-vue - Install dependencies:
npm install. - Change .env-example to .env.
- Create a postgres database and update .env with the credentials (The database url is in the form of
postgres://username:password@host:PORT_NO/database_name) - Set SSL to false in src/database/index.js (
SSL: false) - Run
npm run devto start the app with hot reloading ornpm startto start it normally. - visit http://localhost:3000 (or any port set in the .env file)
To run the tests:
- Ensure you have done items 1-5 above.
- Run
npm test
The API runs on PORT 3000 by default but you can run it on any port you want by updating the port in .env file.
The API docs is available here