Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/irenaeus-xvi/e-commerce

E-Commerce Project is a scalable and customizable platform for online businesses. It's built using Node.js, Express, and MongoDB.
https://github.com/irenaeus-xvi/e-commerce

authentication authorization bycrypt cloudinary dotenv expressjs global-error-handling joi-validation jsonwebtoken mongodb mongoose morgan multer nanoid nodejs nodemailer qrcode-generator slugify stripe-payments

Last synced: 11 days ago
JSON representation

E-Commerce Project is a scalable and customizable platform for online businesses. It's built using Node.js, Express, and MongoDB.

Awesome Lists containing this project

README 

        
# E-Commerce-App



E-Commerce Project is a scalable and customizable platform for online businesses. It's built using Node.js, Express, and MongoDB.

## Getting Started



To get started with the E-Commerce backend, follow these steps:



1. Clone the repository:

   ```sh

   git clone https://github.com/Irenaeus-XVI/E-Commerce.git

   ```

2. Install dependencies:

    ```sh

   cd E-Commerce

   npm install

   ```

3. Set up environment variables:



   Create a `.env` file in the root directory and add the necessary environment variables. You can use the provided .env.example as a template.   



4. Start the server:



```sh 

    npm start

```



The server will start and listen on a specified port (default: 3000). You can access the API using tools like Postman or integrate it with your frontend application.



## Configuration



## MongoDB connection URLs

- `CONNECTIONURL`: MongoDB connection URL for local development.

- `CONNECTIONURLONLINE`: MongoDB connection URL for online deployment.



## Application Mode

- `MODE`: Application mode (dev, prod, etc.).



## Security

- `SALT_ROUNDS`: Number of salt rounds for bcrypt hashing.

- `SECRET_KEY_TOKEN`: Secret key for generating JWT tokens.



## Server Configuration

- `PORT`: Port on which the server will run.



## Stripe Integration

- `STRIPE_SECRET_KEY`: Secret key for Stripe payment integration.



## Web Hook Security

- `WEB_HOOK_SECRET_KEY`: Secret key for securing web hooks.



## Endpoints



### User Authentication



- **Register a new user:**

  - `POST /api/v1/user/signup`



- **Log in a user:**

  - `POST /api/v1/user/signin`



- **Verify user email:**

  - `GET /api/v1/user/verify/:token`



### Product Management



- **Add a new product:**

  - `POST /api/v1/products/add`



- **Update a product:**

  - `PUT /api/v1/products/:productId`



- **Delete a product:**

  - `DELETE /api/v1/products/:productId`



- **Get all products:**

  - `GET /api/v1/products`



### Shopping Cart



- **Add an item to the cart:**

  - `POST /api/v1/cart/add`



- **Remove an item from the cart:**

  - `DELETE /api/v1/cart/remove/:itemId`



- **Update item quantity in the cart:**

  - `PUT /api/v1/cart/update/:itemId`



- **View shopping cart:**

  - `GET /api/v1/cart`



### Order Processing



- **Place an order:**

  - `POST /api/v1/orders/place`



- **View order history:**

  - `GET /api/v1/orders/history`



### User Reviews and Ratings



- **Leave a review for a product:**

  - `POST /api/v1/products/:productId/reviews`



- **View reviews for a product:**

  - `GET /api/v1/products/:productId/reviews`



### Search Functionality



- **Search for products:**

  - `GET /api/v1/products/search`



### User Account Dashboard



- **View user account information:**

  - `GET /api/v1/user/account`



### Admin Dashboard



- **View sales and analytics:**

  - `GET /api/v1/admin/dashboard`



## Global Error Handling and Status Codes



The application employs global error handling to ensure consistent error responses. HTTP status codes are utilized to indicate the nature of errors:



- `404`: Resource not found.

- `400`: Bad request - when the request is malformed or invalid.

- `409`: Conflict - when there is a conflict with the current state of the server (e.g., attempting to create a resource that already exists).

- `500`: Server error.



This approach helps maintain a standardized response format and enhances the user experience by providing meaningful error messages and appropriate HTTP status codes.



## Technologies



- **Backend:**

  - [Node.js](https://nodejs.org/)

  - [Express.js](https://expressjs.com/)

  - [MongoDB](https://www.mongodb.com/)



- **Database:**

  - [Mongoose](https://mongoosejs.com/)



- **Authentication and Authorization:**

  - [bcrypt](https://www.npmjs.com/package/bcrypt)

  - [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken)



- **Middleware:**

  - [cors](https://www.npmjs.com/package/cors)

  - [dotenv](https://www.npmjs.com/package/dotenv)

  - [morgan](https://www.npmjs.com/package/morgan)



- **Validation:**

  - [Joi](https://www.npmjs.com/package/joi)



- **File Upload:**

  - [Multer](https://www.npmjs.com/package/multer)



- **Utility Libraries:**

  - [uuid](https://www.npmjs.com/package/uuid)

  - [slugify](https://www.npmjs.com/package/slugify)



- **Payment Integration:**

  - [Stripe](https://www.npmjs.com/package/stripe)



- **Other Utilities:**

  - [qrcode](https://www.npmjs.com/package/qrcode) (used for generating QR codes)



## Contributing



Contributions are welcome! If you find a bug or have a suggestion, feel free to open an issue or create a pull request.



## License



This project is licensed under the MIT License.