An issue tracker app that employees within a company can post and receive issues from each other. Admin account can add department, add user and update user's settings. This API is paired with Issue Tracker Frontend.
- This API contains two types of permissions,
adminanduserwithin each company. - User is able to read, post, update issues and post comments to issues.
- User is able to update his/her own profile, like name and password.
- Admin has all the features that a user can do, plus extra permission to add a department, add a new user and reset user information like password, department, and permission.
- A user or admin can only access the information that belongs to his/her company.
You can refer to the database design here
- PostgreSQL
- REST API with Node.js Express.js server
- CRUD operation
- Session authentication
- Docker
Note: To enjoy this app, you need this repo to provide the UI, please follow the instruction to start the frontend.
-
Copy the environment variable to
.envfrom.env.examplebycat .env.example >> .env -
Please install Docker, don't worry, it is still free 😆 !
-
Make sure your Docker is up and running and host machine and docker environment are all available for both ports:
5000and5432. Then runmake restartYou can access the API on your host machine via post
5000. Check if the app is up and running bycurl -X GET http://localhost:5000/healthcheck -
You can log in as a non-admin user by credentials
curl -d "email=tom@tomandjerry.com&password=pAssword1@" -X POST http://localhost:5000/loginOr log in as an admin
curl -d "email=admin@tomandjerry.com@&password=pAssword1@" -X POST http://localhost:5000/login
NB: As initial seeds, I put two companies and each company has admin and normal users in the database, you can check out here
-
To stop the container, run
make down
For more come in handy commands, please refer to Makefile
✨✨✨✨✨✨Welcome any ideas to make this project better! Happy Coding 👩🏻💻✨✨✨✨✨✨