No description
src | ||
.dockerignore | ||
.env.example | ||
.gitignore | ||
docker-compose.yaml | ||
Dockerfile | ||
package-lock.json | ||
package.json | ||
README.md | ||
tsconfig.json |
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
- 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:
- Clone the repository.
- Ensure that you have Docker and Docker Compose installed.
- Implement the required environment variables by creating an
.env
file. - Run the following command in the root directory:
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
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"
}