Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sanjithrk06/ezlil-api
A RESTful API for the Ezlil e-commerce website manages core functionalities like products, user accounts, and orders, ensuring seamless backend interaction.
https://github.com/sanjithrk06/ezlil-api
api expressjs mongodb mongoose nodejs restful-api
Last synced: 5 days ago
JSON representation
A RESTful API for the Ezlil e-commerce website manages core functionalities like products, user accounts, and orders, ensuring seamless backend interaction.
- Host: GitHub
- URL: https://github.com/sanjithrk06/ezlil-api
- Owner: sanjithrk06
- License: mit
- Created: 2024-05-23T18:26:55.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-07-16T06:02:36.000Z (6 months ago)
- Last Synced: 2024-11-20T21:09:00.728Z (2 months ago)
- Topics: api, expressjs, mongodb, mongoose, nodejs, restful-api
- Language: JavaScript
- Homepage:
- Size: 1.56 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# **RESTful API for An E-commerce Website (Ezlil)**
## Project Overview
A RESTful API for the Ezlil e-commerce website is designed to provide a robust and scalable interface for managing the core functionalities of the online store. This API allows seamless interaction with the website's backend, enabling the handling of products, user accounts, orders, and other essential e-commerce features.
[Run the application locally](#run-locally)
---
## Tech Stack
**Server:** Node, Express
**Database:** MongoDB
**ODM Tool:** Mongoose
---
## Key Features
- **Product Management:** Endpoints to create, read, update, and delete products.
- **User Authentication:** Secure login, registration, and user profile management.
- **Order Processing:** Endpoints for managing the shopping cart, checkout process, and order history.
- **Inventory Management:** Real-time tracking and updating of stock levels.
- **Payment Integration:** Secure processing of payments via various payment gateways.
- **Search and Filter:** Advanced search and filtering options for product catalog.
- **Review and Rating System:** Endpoints for users to leave reviews and ratings for products.
---
## Stackholders
- **Developers:** Building front-end applications or mobile apps that need to interact with the E-commerce API.
- **E-commerce Managers:** Managing product listings, inventory, and customer orders through custom dashboards or admin panels.
- **Third-party Integrators:** Companies looking to integrate e-commerce capabilities with other services or platforms, such as CRM systems or marketing tools.
- **Customers:** Indirectly benefiting from a more responsive and feature-rich e-commerce experience.
---
## Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`PORT`
`MONGO_URI`
`SECRET`(Secret Key for JWT)
---
Clone the project
```bash
git clone https://github.com/sanjithrk06/Ezlil-API.git
```
Go to the project directory
```bash
cd Ezlil-API
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run start
```
---
*Feel free to reach out through the contact form in [My Portfolio](https://sanjith-portfolio.netlify.app/) or connect with me on social media.