https://github.com/braineanear/ecommerceapi

An API for e-commerce works, built using NodeJS & MongoDB
https://github.com/braineanear/ecommerceapi

api chai ecommerce eslint jwt mocha-chai mongodb nodejs passport redis unit-testing

Last synced: 1 day ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/braineanear/ecommerceapi
• Owner: Braineanear
• Created: 2021-05-03T01:19:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-29T06:50:13.000Z (3 months ago)
• Last Synced: 2024-09-21T01:05:35.372Z (5 days ago)
• Topics: api, chai, ecommerce, eslint, jwt, mocha-chai, mongodb, nodejs, passport, redis, unit-testing
• Language: TypeScript
• Homepage: https://documenter.getpostman.com/view/11050349/2s946feCf5
• Size: 1.53 MB
• Stars: 226
• Watchers: 4
• Forks: 68
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Ecommerce API

Overview

--------

Welcome to the Ecommerce API project! This API is built using NodeJS and MongoDB and provides a comprehensive set of features for managing an e-commerce platform.

Key Features

------------

- Authentication: Secure user authentication mechanisms.

- Password Management: Functionality for password resetting and updating.

- User Management: CRUD operations for managing user profiles.

- Cart Service: Manage user carts, add or remove items.

- Review Service: Allow users to create and manage product reviews.

- Product Service: CRUD operations for products.

- Favorite Service: Manage users' favorite products.

- Order Service: Handle order creation and management.

- Category Service: Organize products into categories.

- Brand Service: Manage product brands.

- Color Service: Support for product colors.

- Size Service: Manage product sizes.

- Tag Service: Tagging functionality for products.

- History Service: Track user activity and history.

- Full Text Search Service: Powerful search capabilities across the platform.

- Multi-Language Support: Support for multiple languages to cater to a global audience.

API Usage

---------

To get started with the API, follow these steps:

1. Clone the repository:

   git clone https://github.com/Braineanear/EcommerceAPI.git

2. Install the dependencies:

   yarn install

3. Add your own `.env` file with the necessary environment variables.

4. Start the development server:

   yarn run start

5. Open http://localhost:8080/docs to view the API documentation in your browser.

6. To test the API using Postman, you can check the Ecommerce API Postman Collection:

   https://documenter.getpostman.com/view/11050349/2s946feCf5

Known Bugs

----------

If you encounter any issues or have questions, ideas, or concerns, please feel free to reach out to me via email at [email protected]. Your feedback is highly appreciated!

Contributing

------------

Contributions are what make the open-source community an amazing place to 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

-------

You can reach me through the following channels:

- Twitter: @Mahmoud03203227 (https://twitter.com/Mahmoud03203227)

- Email: [email protected]

- Facebook: MahmoudYasserMLE (https://www.facebook.com/MahmoudYasserMLE/)

- LinkedIn: Mahmoud Yasser (https://www.linkedin.com/in/braineanear/)

Thank you for your interest in the Ecommerce API project. Feel free to share your opinions, constructive criticism, or comments about my work. Happy coding! 🙂