0xRnato / crud-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CRUD API

This is a simple users CRUD API made with NestJs

API Documentation

For detailed API documentation, please refer to the API Documentation. It provides information about the available endpoints, request payloads, and response formats.

Installation

To run the project, please ensure that you have the following prerequisites installed:

  • Node.js v18.16 or later

Follow the steps below to install and configure the project:

  1. Install the server dependencies:
npm install
  1. Start the server:
npm start

The server will start running at http://localhost:3000.

Running Tests

To run the unit tests, just run the follow command:

npm test

About


Languages

Language:TypeScript 97.3%Language:JavaScript 2.7%