{"id":25008762,"url":"https://github.com/nandanaraju/backend_assignment","last_synced_at":"2026-04-11T03:04:01.395Z","repository":{"id":275466337,"uuid":"926158752","full_name":"nandanaraju/Backend_Assignment","owner":"nandanaraju","description":"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.","archived":false,"fork":false,"pushed_at":"2025-02-02T17:50:16.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-02T18:31:14.340Z","etag":null,"topics":["expressjs","mongoose","nodejs","postman"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nandanaraju.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-02T17:33:43.000Z","updated_at":"2025-02-02T17:50:19.000Z","dependencies_parsed_at":"2025-02-02T18:42:06.497Z","dependency_job_id":null,"html_url":"https://github.com/nandanaraju/Backend_Assignment","commit_stats":null,"previous_names":["nandanaraju/backend_assignment"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nandanaraju%2FBackend_Assignment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nandanaraju%2FBackend_Assignment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nandanaraju%2FBackend_Assignment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nandanaraju%2FBackend_Assignment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nandanaraju","download_url":"https://codeload.github.com/nandanaraju/Backend_Assignment/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246263830,"owners_count":20749358,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["expressjs","mongoose","nodejs","postman"],"created_at":"2025-02-05T03:28:40.703Z","updated_at":"2025-12-30T20:30:03.156Z","avatar_url":"https://github.com/nandanaraju.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 👤 User \u0026 👥 Group Management API\n\n## 📚 Overview  \nThis 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.\n\n## 🛠️ Tech Stack  \n- **Backend:** Node.js, Express.js  \n- **Database:** MongoDB with Mongoose ORM 🐒  \n- **Authentication:** JWT 🔒 (Future enhancement)  \n- **Testing:** Postman 🚀 (for API request validation)  \n\n## 🚀 Installation  \n1. **📥 Clone the repository:**  \n   ```sh  \n   git clone https://github.com/nandanaraju/Backend_Assignment.git  \n   cd Backend_Assignment  \n   ```\n\n2. **📦 Install dependencies:**\n   ```sh\n   npm install\n   ```\n3. **⚙️ Create a `.env` file** and add MongoDB connection:\n   ```env\n   PORT=5000\n   MONGO_URI=mongodb://localhost:27017/task_backend\n   ```\n4. **🚀 Start the server:**\n   ```sh\n   node app.js\n   ```\n\n## 📡  API Endpoints\n### 👤 User Management\n| Method | Endpoint | Description |\n|--------|------------------|-------------------------|\n|➕ POST | `/api/users` | Create a new user |\n|📋 GET | `/api/users` | Retrieve all users |\n| ✏️ PUT | `/api/users/:id` | Update a user's details |\n|🗑️ DELETE | `/api/users/:id` | Delete a user |\n\n### 👥 Group Management\n| Method | Endpoint | Description |\n|--------|------------------------------|----------------------------------|\n|➕POST | `/api/groups` | Create a new group |\n|➕ POST | `/api/groups/:groupId/addMember` | Add a member to a group |\n\n### 🔔 Notification Management\n| Method | Endpoint | Description |\n|--------|-----------------------------|--------------------------------|\n|📋 GET | `/api/notifications/:userId` | Retrieve notifications for a user |\n|✏️ PUT | `/api/notifications/:id/read` | Mark notification as read |\n|🗑️ DELETE | `/api/notifications/:id` | Delete a notification |\n\n## 📈 Scalability Considerations\n- **🗂️ Database Indexing:** Indexed `email` in User schema for fast lookups.\n- **🧩 Microservices:** Separate User, Group, and Notification into independent services.\n- **⚡ Caching:** Use Redis for frequent queries like user profile fetches.\n\n\n\n## 🧪 Testing with Postman\n1. **Published Link** : [Link](https://documenter.getpostman.com/view/36810693/2sAYX3sPKU)\n2. **🔁 Replace `:id`, `:userId`, and `:groupId` with actual values**\n3. **🚀 Run requests and validate responses**\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnandanaraju%2Fbackend_assignment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnandanaraju%2Fbackend_assignment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnandanaraju%2Fbackend_assignment/lists"}