A Simple Role-Based-Ticketing-System"

This is a simple Role-Based-Ticketing-System developed using the MERN full-stack. The system demonstrates user registration and login functionalities with JWT Authentication(access and refresh Token generation + refresh Token rotation and reuse detection) and email verification using Nodemailer.There are 2 roles admin and user saved in the user mongoose model in the role field.

By default any user that is registered has a user role and a superadmin with database access changes their role to admin according to his need from Mongodb atlas.users with a user role can create,read,update(only title and description),delete their own ticket where as admins can see all the tickets from all users and update the status to open, In progress, closed and also delete a ticket.

Prerequisites

Before running the application, ensure you have the following installed:

1. Node.js
2. git

Getting Started

Follow these steps to run the application locally:

To get started, clone this repository to your local machine.

git clone https://github.com/aynuayex/Role-Based-Ticketing-System
cd Role-Based-Ticketing-System

Setting up the Frontend

1. Navigate to the project directory: cd frontend

2. Install dependencies: npm install

3. In the root of the frontend folder create a .env.local file if it didn't already exist and inside paste the VITE_BASE_API like shown below.so, it should look like this:

   VITE_BASE_API=http://localhost:5000/api/v1
   

4. Start the frontend: npm run dev

Setting up the API

1. Navigate to the project directory: cd backend

2. Install dependencies: npm install

3. • Go to Mongodb and create a new Project and obtain the database URL connection string and in the root of the backend folder create a .env file and inside paste to the value of MONGO_URI, add the FRONTEND_URL and also add the PORT, NODE_ENV like shown below.so, it should look like this:

     PORT=5000
     NODE_ENV=development
     FRONTEND_URL=http://localhost:5173
     MONGO_URI=mongodb+srv://yourusername:[email protected]/TicketDB?retryWrites=true&w=majority&appName=Cluster0

   • Add USER and APP_PASS which are needed for the nodemailer to work properly.so, add your email address for the former and for the latter use App Password

     Generate an App Password:

     • Go to App Passwords.
     • Select Mail as the app and "Other (Custom)" as the device.
     • give your app a name,example Ticketing managment system
     • Generate and copy the 16-character password.

     [email protected]
     APP_PASS="paste here the 16-character password"
     

   • ACCESS_TOKEN_SECRET and REFRESH_TOKEN_SECRET: These are encryption keys used to sign the JWT tokens. You should generate these keys using the following command in Node.js:

     require("crypto").randomBytes(64).toString("hex");

     After running the above command in the Node CLI, copy the generated secret and add it to the .env file:

     ACCESS_TOKEN_SECRET=secret_key
     REFRESH_TOKEN_SECRET=secret_key

4. Start the backend server: npm run dev

   The server should now be running on http://localhost:5000.

If I Had More Time

Given more time, I would enhance the project by:

1. Changing All API calls using react query hooks, useQuery and useMutation
2. implement forgot password