https://github.com/nandanaraju/backend_assignment
This is a RESTful API for managing users, groups, and notifications. It enables user profile creation, group management, and automatic notifications when a new member joins a group.
https://github.com/nandanaraju/backend_assignment
expressjs mongoose nodejs postman
Last synced: 3 months ago
JSON representation
This is a RESTful API for managing users, groups, and notifications. It enables user profile creation, group management, and automatic notifications when a new member joins a group.
- Host: GitHub
- URL: https://github.com/nandanaraju/backend_assignment
- Owner: nandanaraju
- Created: 2025-02-02T17:33:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-02T17:50:16.000Z (about 1 year ago)
- Last Synced: 2025-02-02T18:31:14.340Z (about 1 year ago)
- Topics: expressjs, mongoose, nodejs, postman
- Language: JavaScript
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 👤 User & 👥 Group Management API
## 📚 Overview
This is a RESTful API for managing users, groups, and 🔔 notifications. It enables user profile creation, group management, and automatic notifications when a new member joins a group.
## 🛠️ Tech Stack
- **Backend:** Node.js, Express.js
- **Database:** MongoDB with Mongoose ORM 🐒
- **Authentication:** JWT 🔒 (Future enhancement)
- **Testing:** Postman 🚀 (for API request validation)
## 🚀 Installation
1. **📥 Clone the repository:**
```sh
git clone https://github.com/nandanaraju/Backend_Assignment.git
cd Backend_Assignment
```
2. **📦 Install dependencies:**
```sh
npm install
```
3. **⚙️ Create a `.env` file** and add MongoDB connection:
```env
PORT=5000
MONGO_URI=mongodb://localhost:27017/task_backend
```
4. **🚀 Start the server:**
```sh
node app.js
```
## 📡 API Endpoints
### 👤 User Management
| Method | Endpoint | Description |
|--------|------------------|-------------------------|
|➕ POST | `/api/users` | Create a new user |
|📋 GET | `/api/users` | Retrieve all users |
| ✏️ PUT | `/api/users/:id` | Update a user's details |
|🗑️ DELETE | `/api/users/:id` | Delete a user |
### 👥 Group Management
| Method | Endpoint | Description |
|--------|------------------------------|----------------------------------|
|➕POST | `/api/groups` | Create a new group |
|➕ POST | `/api/groups/:groupId/addMember` | Add a member to a group |
### 🔔 Notification Management
| Method | Endpoint | Description |
|--------|-----------------------------|--------------------------------|
|📋 GET | `/api/notifications/:userId` | Retrieve notifications for a user |
|✏️ PUT | `/api/notifications/:id/read` | Mark notification as read |
|🗑️ DELETE | `/api/notifications/:id` | Delete a notification |
## 📈 Scalability Considerations
- **🗂️ Database Indexing:** Indexed `email` in User schema for fast lookups.
- **🧩 Microservices:** Separate User, Group, and Notification into independent services.
- **⚡ Caching:** Use Redis for frequent queries like user profile fetches.
## 🧪 Testing with Postman
1. **Published Link** : [Link](https://documenter.getpostman.com/view/36810693/2sAYX3sPKU)
2. **🔁 Replace `:id`, `:userId`, and `:groupId` with actual values**
3. **🚀 Run requests and validate responses**