Role-Based Login System with Authentication and Authorization

This project is a role-based login system designed to provide secure access control for different users: Schools, Parents, and Students. The system ensures that each type of user can access specific features based on their role.

Table of Contents

• Features
• Technologies Used
• Project Structure
• Setup and Installation
• Running the Project
• API Endpoints
• Environment Variables
• License

Features

• User registration and login
• Email verification
• Role-based access control
• JWT authentication
• Password reset functionality
• CRUD operations for student achievements

Technologies Used

• Node.js
• Express.js
• TypeScript
• Prisma (ORM)
• PostgreSQL
• JWT (JSON Web Tokens)
• Nodemailer
• Zod (Validation)

Project Structure

Setup and Installation

1. Clone the repository:

    
    
    
   sh
   Copy
   git clone https://github.com/theanant404/Role-Based-Login-System-with-Authentication-Authorization.git
   cd Role-Based-Login-System-with-Authentication-Authorization/server

2. Install dependencies:

    
    
    
   sh
   Copy
   npm install

3. Set up environment variables:

   • Create a
     terminal

     Copy

     .env
     file in the server directory.
   • Copy the contents of .env.sample into
     terminal

     Copy

     .env
     and fill in the required values.

4. Set up the database:

   • Ensure you have PostgreSQL installed and running.
   • Update the
     terminal

     Copy

     DATABASE_URL
     in the
     terminal

     Copy

     .env
     file with your PostgreSQL connection string.
   • Run the Prisma migrations to set up the database schema:

    
    
    
   sh
   Copy
   npx prisma migrate dev

Running the Project

1. Build the project:

    
    
    
   sh
   Copy
   npm run build

2. Start the server:

    
    
    
   sh
   Copy
   npm run start

3. For development:

    
    
    
   sh
   Copy
   npm run dev

   This will start the server with hot-reloading enabled.

API Endpoints

Auth Routes

• POST /auth/register - Register a new user
• POST /auth/verify-email - Verify user email with OTP
• GET /auth/login - Login user
• POST /auth/forgot-password - Send OTP for password reset
• POST /auth/reset-password - Reset user password
• POST /auth/logout - Logout user

Dashboard Routes

• GET /dashboard/ - Get user dashboard
• GET /dashboard/student/:id - Get student details (School role only)
• POST /dashboard/add-achievement/:id - Add new achievement (School role only)
• DELETE /dashboard/deleteachievement/:id - Remove student achievement (School role only)
• DELETE /dashboard/deleteuser/:id - Delete user (School role only)

Environment Variables

The following environment variables need to be set in the

file:

• terminal

  Copy

  DATABASE_URL
  - PostgreSQL connection string
• PORT - Server port
• SMTP_HOST - SMTP host for sending emails
• SMTP_PORT - SMTP port
• SMTP_USER - SMTP user
• SMTP_PASSWORD - SMTP password
• FROM_EMAIL - Email address to send emails from
• ACCESS_TOKEN_SECRET - Secret key for access token
• REFRESH_TOKEN_SECRET - Secret key for refresh token

License

This project is licensed under the MIT License. See the LICENSE file for details.