README

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
+
+