Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sandipkushwaha20/codebuddy-backend
CodeBuddy is a MERN stack-based web application designed to connect developers based on shared skills, interests, and profiles.
https://github.com/sandipkushwaha20/codebuddy-backend
expressjs mongodb mongoose nodejs nodemon
Last synced: 25 days ago
JSON representation
CodeBuddy is a MERN stack-based web application designed to connect developers based on shared skills, interests, and profiles.
- Host: GitHub
- URL: https://github.com/sandipkushwaha20/codebuddy-backend
- Owner: Sandipkushwaha20
- Created: 2024-12-28T09:53:20.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-19T13:42:42.000Z (27 days ago)
- Last Synced: 2025-01-19T14:46:37.612Z (27 days ago)
- Topics: expressjs, mongodb, mongoose, nodejs, nodemon
- Language: JavaScript
- Homepage:
- Size: 111 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🛠️ CodeBuddy Backend
#### For Frontend [Click Here](https://github.com/Sandipkushwaha20/CodeBuddy-Frontend.git)
CodeBuddy Backend is the server-side component of the CodeBuddy project, a platform designed to connect developers based on shared skills, interests, and profiles. This backend service handles user authentication, profile management, connection requests, and more.
---
## 📊 Features
### User Authentication:
- Secure user registration, login, and logout using JWT.
### Profile Management:
- Create, view, and edit user profiles.
### Connection Requests:
- Send, review, and manage connection requests between users.
### User Feed:
- Display profiles of other users on the platform.
---
## ⚙️ Tech Stack
- **Backend**: Node.js, Express
- **Database**: MongoDB
- **Authentication**: JWT
---
## 🔧 Installation
Follow these steps to set up and run the backend locally:
### Prerequisites
- **Node.js**
- **MongoDB**
- **npm** (Node Package Manager)
### Clone the Repository
```bash
git clone https://github.com/Sandipkushwaha20/CodeBuddy.git
cd CodeBuddy/backend
npm install
```
### Start the Server
```bash
npm run dev
```
---
## 📊 API Endpoints
### Auth Routes
- **POST** `/signup`: Register a new user.
- **POST** `/login`: Login an existing user.
- **POST** `/logout`: Logout the current user.
### Profile Routes
- **GET** `/profile/view`: View the current user's profile.
- **PATCH** `/profile/edit`: Edit the current user's profile.
- **PATCH** `/profile/password`: Change the current user's password.
### Connection Request Routes
- **POST** `/request/send/:status/:userId`: Send a connection request to a user. `status` can be `interested` or `ignored`.
- **POST** `/request/review/:status/:requestId`: Review a connection request. `status` can be `accepted` or `rejected`.
### User Routes
- **GET** `/user/requests`: Get the current user's connection requests.
- **GET** `/user/connections`: Get the current user's connections.
- **GET** `/user/feed`: Get profiles of other users on the platform.
---
## 📁 Project Structure
```plaintext
CodeBuddy/
├── .gitignore
├── package.json
├── README.md
├── src/
│ ├── app.js
│ ├── config/
│ │ └── database.js
│ ├── middlewares/
│ │ └── auth.js
│ ├── models/
│ │ ├── connectionRequest.js
│ │ └── user.js
│ ├── routes/
│ │ ├── auth.js
│ │ ├── profile.js
│ │ ├── request.js
│ │ └── user.js
│ └── utils/
│ └── validation.js
```
---
## 🔄 Workflow Diagram
```mermaid
graph TD
A[User Registration/Login] --> B[User Authentication]
B --> C[Profile Management]
C --> D[Connection Requests]
D --> E[User Feed]
E --> F[View Other User Profiles]
F --> G[Send Connection Requests]
G --> H[Review Connection Requests]
H --> I[Manage Connections]
```
---
## 🚀 Example Usage
1. **Run the Server**:
- Start the backend server using `npm run dev`.
2. **Test the API**:
- Use tools like Postman to test endpoints such as `/signup` and `/login`.
3. **Integration**:
- Connect this backend with the frontend or any client for a full-stack application.
---
## 🔧 Future Improvements
- Add email notifications for connection requests.
- Implement real-time messaging between users.
- Add pagination and filtering options to the user feed.
---
## 📢 Credits
- Developed by: Sandip Kushwaha
---