zulkar29 / node-js-assingment

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Node.js Assignments

Completed Time

Approximately 4 hours

Technology

  • API: Express.js, MongoDB

Project Overview

Backend Project Architecture

The project follows a Service-Controller-Model architecture.

How to Run

Option 1: Using Docker

  1. Clone the project:

    git clone https://github.com/zulkar29/node-js-assingment.git
    
  2. Build Docker image:

    docker build -t my-node-app .
    
  3. Run Docker container:

    docker run -p 3001:3001 my-node-app
    

Option 2: Without Docker

  1. Clone the project:

    git clone https://github.com/zulkar29/node-js-assingment.git
    
  2. Navigate to the project directory:

    cd node-js-assingment
    
  3. Install dependencies:

    npm install
    
  4. Run the project:

    npm run dev
    

URLs

API Documentation

API documentation is available on Postman documentation

Features Completed

  • Create User
  • Show All Users
  • Show Single User

Containerization

  • Docker-based containerization for easy deployment.

API Response Enhancement

  • API responses include validation messages.

API Endpoint Naming Convention

  • Followed a consistent API endpoint naming convention.

Note

I have a clear understanding of the full software development life cycle as a full-stack developer both as an individual and as part of a team. Given the opportunity for an interview, I am confident in my ability to showcase my skills effectively. Thank you.

About


Languages

Language:JavaScript 97.3%Language:Dockerfile 2.7%