ecomm/README.md

74 lines
1.6 KiB
Markdown
Raw Normal View History

2023-06-11 10:01:50 +00:00
# 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:
2023-06-11 10:05:40 +00:00
````
2023-06-11 10:01:50 +00:00
docker-compose up
2023-06-11 10:05:40 +00:00
```
2023-06-11 10:01:50 +00:00
The application will be running on port 3000, and the database will be running on port 27017.
API Documentation
2023-06-11 10:05:40 +00:00
# Users
2023-06-11 10:01:50 +00:00
Create a New User - POST /users
2023-06-11 10:05:40 +00:00
Creates a new user[#create-a-new-user---post-users].
2023-06-11 10:01:50 +00:00
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"
}
```