diff --git a/README.md b/README.md index e69de29..1756e9c 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,73 @@ +# Ecomm Backend + +This repository contains the backend implementation for the Ecomm e-commerce application. + +## Description + +This is a simple e-commerce backend application built with Node.js, TypeScript, Express.js, MongoDB, and Docker. It provides API endpoints to manage users and products. + +## Table of Contents + +- [Technologies Used](#technologies-used) +- [How to Run](#how-to-run) +- [API Documentation](#api-documentation) + - [Users](#users) + - [Create a New User](#create-a-new-user---post-users) + - [Login](#login---post-userslogin) + - [Products](#products) + - [Get All Products](#get-all-products---get-products) + +## Technologies Used + +- Node.js +- TypeScript +- Express.js +- MongoDB +- Mongoose ORM +- Docker (docker-compose) +- bcrypt +- JWT + +## How to Run + +To run the Ecomm backend application, follow these steps: + +1. Clone the repository. +2. Ensure that you have Docker and Docker Compose installed. +3. Implement the required environment variables by creating an `.env` file. +4. Run the following command in the root directory: + ```shell + docker-compose up + +The application will be running on port 3000, and the database will be running on port 27017. + +API Documentation +Users +Create a New User - POST /users +Creates a new user. + +Request Body + +``` +{ + "name": "string", + "email": "string", + "password": "string" +} +``` +Response Body +``` +{ + "user": { + "_id": "string", + "name": "string", + "email": "string", + "password": "string", + "createdAt": "string", + "updatedAt": "string", + "__v": "number" + }, + "token": "string" +} +``` +