Project Overview

This Node.js project Assignment manages users using MongoDB with Mongoose. It provides CRUD operations through a RESTful API and includes basic authentication using a single secret key.

Setup Instructions

1. Clone the repository

   • Clone the repository to your local machine:

     git clone https://github.com/git-ashutosh571/Worko.ai-Nodejs-Assignment.git
     

2. Install dependencies

   • Install Node.js dependencies:

     npm install
     

3. Set up environment variables

   • Create a .env file in the root directory with the following environment variables:

     PORT=3000
     MONGODB_URI=mongodb://localhost:27017/
     SECRET_KEY=admin123
     

     • PORT: Port on which the server will run.
     • MONGODB_URI: URI for your MongoDB database.
     • SECRET_KEY: Secret key for basic authentication.

4. Start the server

   • Start the Node.js server:

     npm start
     

   • The server will run at http://localhost:3000.

API Documentation

Users API

• POST /worko/user/

  • Creates a new user.
  • Request body should contain email, name, age, city, and zipCode.

• GET /worko/user/

  • Retrieves all users.

• GET /worko/user/:userId

  • Retrieves a user by userId.

• PUT /worko/user/:userId

  • Updates a user by userId.
  • Request body can contain email, name, age, city, and zipCode.

• DELETE /worko/user/:userId

  • Soft deletes a user by userId.

Basic Authentication

• All API endpoints require basic authentication using the Authorization header with a value of SECRET_KEY in .env file.

Additional Notes

• Ensure MongoDB is running and accessible via the provided MONGODB_URI.
• Ensure passing the correct SECRET_KEYas set in .env file in the authorization header.
• Ensure there is no typing or spelling mistake in passing the key-values to api endpoints.

Tests

Test Descriptions

The project includes tests for controllers, routes, and services to ensure the API functions correctly.

User Controller Tests

GET /worko/user

• Description: Tests retrieving all users from the database.
• Expected Result: Should return a status of 200 and an array of users.

POST /worko/user

• Description: Tests creating a new user.
• Expected Result: Should return a status of 201 and the details of the created user.

User Routes Tests

GET /worko/user

• Description: Tests retrieving all users from the database.
• Expected Result: Should return a status of 200 and an array of users.

POST /worko/user

• Description: Tests creating a new user.
• Expected Result: Should return a status of 201 and the details of the created user.

User Service Tests

createUser

• Description: Tests creating a new user through the service layer.
• Expected Result: Should create a new user successfully.

getUsers

• Description: Tests retrieving all users through the service layer.
• Expected Result: Should retrieve all users successfully.

Running Tests

To run the tests, use the following command:

     npm test