DhyeyVora-1706 / User-Management-API

REST API implementation of User Management System

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

User Management API

Objective

Develop a user management API using Node.js and Express.js with TypeScript and link the API to a database.

Table of Contents

  1. Requirements
  2. Technologies Used
  3. Installation
  4. Usage
  5. API Documentation
  6. Testing
  7. Contributors

Requirements

  • Implement CRUD operations for managing users.
  • Utilize Node.js for backend development.
  • Use Express.js for API creation with TypeScript.
  • Link the API to a database (e.g., MongoDB, PostgreSQL).
  • Write test cases for the API endpoints using Jest.
  • Ensure proper error handling and validation for API requests.
  • Document the API endpoints using tools like Swagger or OpenAPI.

Technologies Used

  • Node.js
  • Express.js (with TypeScript)
  • MongoDB or PostgreSQL
  • Jest (for testing)
  • Swagger or OpenAPI (for API documentation)

Installation

Prerequisites

  • Node.js (>=14.x)
  • npm (>=6.x) or yarn
  • MongoDB or PostgreSQL

Steps

  1. Clone the repository

    Navigate to local folder where repo is cloned by cd your-repository

  2. Run the application npm start (Includes dependency installation , build and running the project)

Usage

CRUD Operations

  • Create, Read, Update, and Delete users using the API endpoints.

API Documentation

  • Swagger or OpenAPI documentation can be accessed at /api/docs.

Testing

Running Tests

sh npm run test

or

yarn test

Contributors

About

REST API implementation of User Management System


Languages

Language:TypeScript 93.6%Language:Dockerfile 6.4%