farhdibehnamdev / ecommerceapi

An API for e-commerce works, built using NodeJS & MongoDB

Ecommerce API

E-commerce API built using NodeJS & MongoDB

Table of Contents

1. Key Features
2. API Usage
3. Known Bugs
4. Contributing
5. Contact

Key Features

• Authentication
• Password Management
• User Management
• Cart Service
• Review Service
• Product Service
• Favorite Service
• Order Service
• Category Service
• Brand Service
• Color Service
• Size Service
• Tag Service
• History Servicee
• Full Text Search Service
• Multi-Language Support

API Usage

1. Clone repo.
2. Run yarn intall.
3. Add your own .env file.
4. Run yarn run start:dev.
5. Open http://localhost:8080/docs to view docs in the browser.
6. You can also check the postman collection Ecommerce API to test the API by yourself.

Known Bugs

Feel free to email me at [email protected] if you run into any issues or have questions, ideas or concerns. Please enjoy and feel free to share your opinion, constructive criticism, or comments about my work. Thank you! 🙂

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Twitter - @Mahmoud03203227

Email - [email protected]

Facebook - MahmoudYasserMLE

LinkedIn - Mahmoud Yasser