From 22429a7b3201ee62a37da169a9849ec2146ab0ee Mon Sep 17 00:00:00 2001 From: Kfir Dayan Date: Sun, 11 Jun 2023 12:10:49 +0300 Subject: [PATCH] README --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d7f234e --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Ecomm # + +## Description ## +This is a simple e-commerce backend application. + +Technologies used: + +* Node.js +* typescript +* Express.js +* MongoDB +* Mongoose ORM +* Docker (docker-compose) +* bcrypt +* JWT +* Swagger + +## How to run ## +1. Clone the repository +2. Make sure you have docker and docker-compose installed +3. Implement the .env file +4. Run `docker-compose up` in the root directory + The application will be running on port 3000 + The database will be running on port 27017 + +## API ## +The API is documented using Swagger. You can access the documentation by running the application and accessing the following URL: http://localhost:3000/api-docs + +