Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/divspark/worko-assignment
This project is in response to worko assignment
https://github.com/divspark/worko-assignment
express-js javascript joi-validation mongodb mongoose node-js
Last synced: about 3 hours ago
JSON representation
This project is in response to worko assignment
- Host: GitHub
- URL: https://github.com/divspark/worko-assignment
- Owner: divspark
- Created: 2024-06-24T17:50:07.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-26T04:34:44.000Z (5 months ago)
- Last Synced: 2024-06-26T22:07:35.163Z (5 months ago)
- Topics: express-js, javascript, joi-validation, mongodb, mongoose, node-js
- Language: JavaScript
- Homepage: https://worko-assignment.vercel.app
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Node.js Express MongoDB Application
This project is a web application built using Node.js, Express, and MongoDB. It includes user authentication with JWT and features for user registration, login, and applying for referrals.
## Features
- User registration and login
- JWT-based authentication
- Referral application
- Data storage in MongoDB
## Technologies Used
- Node.js
- Express.js
- MongoDB
- Mongoose
- JWT (JSON Web Tokens)
- EJS (Embedded JavaScript templates)
## Prerequisites
- Node.js installed on your machine
- MongoDB installed and running
## Getting Started
### Installation
1. Clone the repository:
```sh
git clone https://github.com/divspark/Worko-assignment.git
```
2. Navigate to the project directory:
```sh
cd your-repo
```
3. Install dependencies:
```sh
npm install
```
### Environment Variables
Create a `.env` file in the root of the project and add the following variables:
```env
PORT=4000
MONGODB_URI=your-mongodb-uri
```
### Running the Application
Start the server:
```sh
npm start
```
The server will start on `http://localhost:4000`.
## API Endpoints
### User Routes (`/user`)
- **POST /user/signup**
- Description: Register a new user
- Body Parameters:
- `username` (string)
- `email` (string)
- `password` (string)
- `name` (string)
- `age` (number)
- `city` (string)
- `zipCode` (string)
- **POST /user/login**
- Description: Login a user
- Body Parameters:
- `email` (string)
- `password` (string)
- **POST /user/:id/update**
- Description: Update user details
- Body Parameters (all fields are optional):
- `username` (string)
- `email` (string)
- `name` (string)
- `age` (number)
- `city` (string)
- `zipCode` (string)
### Referral Routes (`/referral`)
- **POST /referral/apply**
- Description: Apply for a referral
- Body Parameters:
- `userId` (string)
- `referralDetails` (string)
## Authentication
This application uses JWT for authentication. Upon successful login, a JWT token is issued to the user. This token must be included in the `Authorization` header for accessing protected routes.
Example:
```sh
Authorization: Bearer
```
## Folder Structure
```plaintext
.
├── controllers
│ ├── userController.js
│ ├── referralController.js
├── models
│ ├── userModel.js
│ ├── referralModel.js
├── routes
│ ├── userRoutes.js
│ ├── referralRoutes.js
├── services
│ ├── userService.js
│ ├── referralService.js
├── middlewares
│ ├── authMiddleware.js
├── views
│ ├── signup.ejs
│ ├── login.ejs
│ ├── updateProfile.ejs
├── .env
├── app.js
├── package.json
└── README.md
```