https://github.com/bire210/crmsystem
This is a RESTFUL API for a CRM System. A Customer Relationship Management (CRM) system using Node.js, Express, MongoDB, and JWT authentication.
https://github.com/bire210/crmsystem
authentication express javascript jwt-authentication mongodb mongoose nodejs
Last synced: 3 months ago
JSON representation
This is a RESTFUL API for a CRM System. A Customer Relationship Management (CRM) system using Node.js, Express, MongoDB, and JWT authentication.
- Host: GitHub
- URL: https://github.com/bire210/crmsystem
- Owner: bire210
- Created: 2023-07-14T01:49:20.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-14T04:01:42.000Z (almost 3 years ago)
- Last Synced: 2025-02-08T19:30:29.375Z (over 1 year ago)
- Topics: authentication, express, javascript, jwt-authentication, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage: https://crmsystem.onrender.com
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Customer Relationship Management
This is a RESTFUL API for a CRM System. A Customer Relationship Management (CRM) system using Node.js, Express, MongoDB, and JWT authentication. The CRM system allows employees or counsellors to effectively manage and track customer enquiries, and claim leads, and access both public and private enquiries within the system.
**Tech Stacks:** Node, Express, MongoDB Atlas
## Video Presentation
**Video Link** -
## Deployment
**Server side:** Render cloud https://crmsystem.onrender.com
## Features
The CRM system backend offers the following features:
- Employee/counsellor registration and login functionality.
- API validation
- Any user can raise an enquiry for course-related doubt without authentication. In this API endpoint No need for Authentication
- APIs to claim leads and assign them to specific employees/counsellors. This is a private.
- APIs to fetch unclaimed leads. This is a private.
- API to fetch leads claimed by logged-in users. This is a private.
- Error handling
### Run Locally Clone this Project
```
- step 1. https://github.com/bire210/crmsystem.git
- step 2. Go to the root directory
- step 3. Install the required dependency by using the command - npm i
- step 4. Set the environment variables MongoDB url and JWT_KEY
- step 5. Write "npm start" in terminal
```
### Runs the project in the development mode
[http://localhost:8080](http://localhost:8080)
## NPM Packages
## API Endpoints
#### Register a new employee/counsellor.
```javascript
POST http://localhost:8080/api/auth/register
```
#### Employee/counsellor login and generate JWT token.
```javascript
POST http://localhost:8080/api/auth/login
```
#### Raise a public enquiry by the user.
```javascript
POST http://localhost:8080/api/enquiry
```
#### to claim leads and assign them to specific employees/counsellors
```javascript
GET http://localhost:8080/api/leads/leadId/claim
```
#### to fetch unclaimed leads.
```javascript
POST http://localhost:8080/api/leads/unclaimed
```
#### to fetch leads claimed by logged-in users
```javascript
POST http://localhost:8080/api/leads/claimed
```
| `Authors` |
| :-------: |
[@bire210](https://github.com/bire210)