A simple CRUD (Create, Read, Update, Delete) API for managing users, built with TypeScript and Node.js.
- Create, read, update, and delete users.
- Simple and intuitive API structure.
- Handles various HTTP methods with appropriate responses.
- Clone the repository:
git clone https://github.com/jpaberzs/CRUD_API.git
cd CRUD_API- Install the dependencies:
npm install- Create a .env file in the root directory and set the port:
PORT=4000
To start the development server, run:
npm run start:devTo start the production server, run:
npm run start:prodTo start multi server, run:
npm run start:multiUser Routes
- GET /api/users - Retrieve all users
- GET /api/users/:userId - Retrieve a user by ID
- POST /api/users - Create a new user
- PUT /api/users/:userId - Update an existing user by ID
- DELETE /api/users/:userId - Delete a user by ID
Response Codes
- 200 OK - Successful operation
- 201 Created - User successfully created
- 204 No Content - User successfully deleted
- 400 Bad Request - Invalid user ID or data
- 404 Not Found - User not found
- start:prod: Build and start the production server.
- start:dev: Start the development server with TypeScript support using ts-node.
- start:multi: Start the development server with multiple ports and TypeScript support using ts-node.
- Node.js - JavaScript runtime for building the API.
- TypeScript - For static typing and modern JavaScript features.
- webpack - Module bundler for building the project.
This project is licensed under the ISC License.