SoarInc: Node.js School Management API

A Node.js-based API for managing schools, classrooms, and students. It includes user authentication, role-based access control, and CRUD operations.

---

Features

• Authentication and Authorization:
  Role-based access control (superAdmin for managing schools).

• CRUD Operations:
  Create, Read, Update, and Delete schools, classrooms, and students.

• Validation:
  Input validation using Joi.

• Database:
  MongoDB for data persistence.

---

Prerequisites

Ensure you have the following installed on your system:

1. Node.js (v16 or higher)
   Download Node.js

2. npm (comes with Node.js) or yarn

3. MongoDB (Local or Cloud)
   Download MongoDB or use MongoDB Atlas.

4. A code editor like Visual Studio Code.

---

Setup Instructions

Follow the steps below to set up and run the project locally:

1. Clone the Repository

git clone https://github.com/chaitanya-dharpale0209/soarinc.git
cd soar

2. Install Dependencies

npm install

3. Configure Environment Variables

Create a .env file in the project root directory and add the following environment variables:

PORT=5000
MONGO_URI=<Your MongoDB Connection String>
JWT_SECRET=<Your JWT Secret>

Replace with the connection string for your MongoDB database (local or Atlas). Replace with a secret key for signing JSON Web Tokens.

4. Start MongoDB

If you’re running MongoDB locally, start it using the command:

mongod

5. Start the Server

Run the following command to start the server:

node server.js

The server will start on http://localhost:5000.

6. Test API Endpoints

Use Postman or any API client to test the endpoints. Below are some of the main routes:

Authentication Routes POST /api/auth/login: Authenticate a user. School Routes (Protected, superAdmin role required) POST /api/schools: Create a new school. GET /api/schools/getallschools: Get all schools. PUT /api/schools/updateschool/:id: Update school details. DELETE /api/schools/deleteschool/:id: Delete a school. Note: Set the Authorization header to Bearer for protected routes.

** api documentation link**

https://documenter.getpostman.com/view/24612054/2sAYJ1kh9i

Database Design and Schema

1. Users Collection

• Purpose: Manages authentication and role-based access control.
• Fields:
  • name (String, required)
  • email (String, required, unique)
  • password (String, required)
  • role (String, enum: superAdmin, schoolAdmin)
  • schoolId (ObjectId, references School)

2. Schools Collection

• Purpose: Stores school information.
• Fields:
  • name (String, required)
  • address (String, required)
  • contactNumber (String, required)

3. Students Collection

• Purpose: Tracks student enrollment and transfers.
• Fields:
  • name (String, required)
  • email (String, required, unique)
  • schoolId (ObjectId, references School)
  • status (String, enum: enrolled, transferred)
  • transferToSchoolId (ObjectId, references School)

4. Classrooms Collection

• Purpose: Manages classrooms and resources.
• Fields:
  • name (String, required)
  • capacity (Number, required)
  • resources (Array of Strings, required)
  • schoolId (ObjectId, references School)

Validators

• StudentValidator: Validates student data.
• SchoolValidator: Validates school data.
• ClassroomValidator: Validates classroom data.

Users | | Manages v Schools | | Contains v Classrooms | | Contains v Students

Users Collection

Users Collection

Field	Type	Required	Notes
name	String	Yes
email	String	Yes	Must be unique.
password	String	Yes
role	String	Yes	Enum: superAdmin, schoolAdmin.
schoolId	ObjectId	No	References the School collection.

---

Schools Collection

Field	Type	Required	Notes
name	String	Yes	Name of the school.
address	String	Yes	Full address of the school.
contactNumber	String	Yes	Phone number for contacting the school.

---

Classrooms Collection

Field	Type	Required	Notes
name	String	Yes	Name or identifier for the classroom.
capacity	Number	Yes	Maximum number of students.
resources	Array[String]	Yes	List of resources (e.g., projector).
schoolId	ObjectId	Yes	References the School collection.

---

Students Collection

Field	Type	Required	Notes
name	String	Yes	Name of the student.
email	String	Yes	Must be unique.
schoolId	ObjectId	Yes	References the School collection.
status	String	Yes	Enum: enrolled, transferred.
transferToSchoolId	ObjectId	No	References the School collection.