📝 Notes Management Dashboard

A full-stack Notes Management application with secure authentication, role-based access control, and complete CRUD functionality for managing notes.

---

🚀 Tech Stack

Layer	Technologies
Frontend	React.js (Vite), Redux Toolkit, React Router DOM, Tailwind CSS, Axios
Backend	Node.js, Express.js, Sequelize ORM
Database	PostgreSQL
Auth & Security	JWT, bcryptjs, Joi Validation

---

✨ Features

Backend

• JWT-based authentication & authorization
• Password hashing with bcryptjs
• Role-based access control — User / Analyst / Admin
• RESTful API with versioning (/api/v1)
• Input validation using Joi
• Centralized error handling
• PostgreSQL integration via Sequelize ORM

Frontend

• Login & Registration UI
• Protected dashboard routes
• Role-based navigation
• Notes CRUD functionality
• Toast notifications
• Responsive UI with Tailwind CSS

---

📁 Project Structure

project/
├── backend/
│   ├── src/
│   │   ├── config/
│   │   ├── controllers/
│   │   ├── middleware/
│   │   ├── models/
│   │   ├── routes/
│   │   ├── services/
│   │   ├── validations/
│   │   ├── utils/
│   │   ├── seeders/
│   │   └── app.js
│   ├── .env.example
│   ├── package.json
│   └── server.js
│
└── frontend/
    ├── src/
    ├── .env.example
    ├── index.html
    ├── tailwind.config.js
    ├── vite.config.js
    └── package.json

---

⚙️ Prerequisites

Make sure you have the following installed before running the project:

• Node.js (v18 or above)
• PostgreSQL (v14 or above)
• npm (comes with Node.js)

---

🛠️ Installation & Setup

1. Clone the Repository

git clone <your-repository-url>
cd project

---

2. Set Up PostgreSQL Database

Open your PostgreSQL client and run:

CREATE DATABASE notes_management;

---

3. Configure Backend Environment

cd backend
cp .env.example .env

Open .env and fill in your values:

PORT=5000
DB_HOST=localhost
DB_PORT=5432
DB_NAME=notes_management
DB_USER=your_postgres_username
DB_PASSWORD=your_postgres_password
JWT_SECRET=your_jwt_secret_key

---

4. Install & Run Backend

# Inside /backend
npm install
npm run dev

The backend runs at: http://localhost:5000

---

5. Seed the Database

# Inside /backend
npm run seed

This creates demo users (User, Analyst, Admin roles) and sample notes automatically.

---

6. Configure Frontend Environment

cd ../frontend
cp .env.example .env

Open .env and set:

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

---

7. Install & Run Frontend

# Inside /frontend
npm install
npm run dev

The frontend runs at: http://localhost:5173

---

🔐 Demo Credentials

👤 User Accounts

Email	Password
upal@example.com	Upal@123
mihir@example.com	Mihir@123
akshat@example.com	Akshat@123

🔍 Analyst Accounts

Email	Password
aditya@example.com	Aditya@123
jay@example.com	Jay@123

🛡️ Admin Account

Email	Password
umang@example.com	Umang@123

---

📡 API Overview

Base URL: http://localhost:5000/api/v1

Use Postman to test all endpoints. Set Authorization: Bearer <token> in the header for protected routes.

---

🔑 Auth Routes — /auth

Method	Endpoint	Description	Auth	Roles
POST	/auth/register	Register a new user	No	—
POST	/auth/login	Login and receive JWT token	No	—
GET	/auth/me	Get current logged-in user	Yes	All
POST	/auth/logout	Logout (stateless confirmation)	Yes	All

POST /auth/register — Request Body:

{
  "name": "John Doe",
  "email": "john@example.com",
  "password": "John@123",
  "role": "user"
}

POST /auth/login — Request Body:

{
  "email": "john@example.com",
  "password": "John@123"
}

---

📝 Notes Routes — /notes

Method	Endpoint	Description	Auth	Roles
GET	/notes	Get notes (own for user, all for admin/analyst)	Yes	All
GET	/notes/my-notes	Get only the logged-in user's notes	Yes	All
GET	/notes/:id	Get a single note by ID	Yes	All
POST	/notes	Create a new note	Yes	User, Admin
PUT	/notes/:id	Update a note	Yes	User, Admin
DELETE	/notes/:id	Delete a note	Yes	User, Admin

POST /notes — Request Body:

{
  "title": "My Note Title",
  "description": "Note content goes here"
}

PUT /notes/:id — Request Body (partial update allowed):

{
  "title": "Updated Title",
  "description": "Updated content"
}

---

👥 User Routes — /users

Method	Endpoint	Description	Auth	Roles
GET	/users	Get all users	Yes	Admin
GET	/users/stats	Get user count by role	Yes	Admin, Analyst
GET	/users/:id	Get a user by ID	Yes	All
PUT	/users/:id	Update user details	Yes	All (own) / Admin
DELETE	/users/:id	Delete a user	Yes	Admin

---

📊 Analytics Routes — /analytics

Method	Endpoint	Description	Auth	Roles
GET	/analytics/overview	Total notes, users, recent activity	Yes	Analyst, Admin
GET	/analytics/notes-per-user	Note count grouped by user	Yes	Analyst, Admin
GET	/analytics/timeline	Notes created over last 30 days	Yes	Analyst, Admin
GET	/analytics/recent-activity	10 most recent notes	Yes	Analyst, Admin
GET	/analytics/user-activity	Activity metrics per user	Yes	Analyst, Admin

---

🔧 Postman Setup Tips

1. Create an Environment in Postman with variable base_url = http://localhost:5000/api/v1
2. After login, copy the token from the response and set it as environment variable token
3. Add to Auth header on protected requests: Authorization: Bearer {{token}}
4. Use Content-Type: application/json header on all POST/PUT requests

---

🔒 Security

• JWT tokens for stateless authentication
• Passwords hashed with bcryptjs
• Protected routes via middleware
• Role-based authorization (User / Analyst / Admin)
• Request body validation with Joi
• Environment variables for sensitive configuration

---

🧑‍💻 Author

Developed by Upal Vasava

---

📄 License

This project is for educational/demo purposes. Feel free to fork and build upon it.