https://github.com/muhammadhabibfery/mern-simple-commerce-api
REST API for E-Commerce platform using MERN Stack
https://github.com/muhammadhabibfery/mern-simple-commerce-api
express-ecommerce-api express-ecommerce-project express-marketplace-api express-marketplace-project express-rest-api mern-stack mern-stack-ecommerce mern-stack-marketplace
Last synced: 12 months ago
JSON representation
REST API for E-Commerce platform using MERN Stack
- Host: GitHub
- URL: https://github.com/muhammadhabibfery/mern-simple-commerce-api
- Owner: muhammadhabibfery
- Created: 2024-06-22T09:23:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-07T10:08:57.000Z (almost 2 years ago)
- Last Synced: 2025-06-01T09:16:22.160Z (about 1 year ago)
- Topics: express-ecommerce-api, express-ecommerce-project, express-marketplace-api, express-marketplace-project, express-rest-api, mern-stack, mern-stack-ecommerce, mern-stack-marketplace
- Language: JavaScript
- Homepage: https://api-mern-commerce.muhammadhabibfery.com/api/v1
- Size: 211 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
MERN COMMERCE API
REST API for E-Commerce platform.
| [Requirements][] | [Install][] | [How to setting][] | [API Docs][] | [License][] |
## Requirements
bcryptjs = ^2.x
cookie-parser = ^1.x
cors = ^2.x
dotenv = ^16.x
email-templates = ^11.x
express = ^4.x
express-async-errors = ^3.x
express-fileupload = ^1.x
express-mongo-sanitize = ^2.x
express-rate-limit = ^7.x
helmet = ^7.x
http-status-codes = ^2.x
joi = ^17.x
jsonwebtoken = ^9.x
mongoose = ^8.x
mongoose-unique-validator = ^5.x
nodemailer = ^6.x
pug = ^3.x
rate-limiter = ^0.x
stripe = ^16.x
swagger-ui-express = ^5.x
dev dependecies:
@eslint/js = ^9.x
eslint = ^9.x
globals = ^15.x
## Install
Clone repo
HTTPS:
```
git clone https://github.com/muhammadhabibfery/mern-simple-commerce-api.git
```
SSH:
```
git clone git@github.com:muhammadhabibfery/mern-simple-commerce-api.git
```
Install Nodejs
[Download Node.js](https://nodejs.org/en/download)
Install Nodemon Globally
```
npm install -g nodemon
```
Install Dependencies
```
npm install
```
## How to setting
Create .env file, then setup some configuration with your own credentials
```
NODE_ENV=development
PORT=3000
MONGO_URI=
COOKIE_KEY=
JWT_SECRET_KEY=
STRIPE_PUBLISHABLE_KEY=
STRIPE_SECRET_KEY=
MAIL_HOST=
MAIL_PORT=
MAIL_USERNAME=
MAIL_PASSWORD=
MAIL_FROM_NAME=
MAIL_FROM_ADDRESS=
```
Run the admin seeder
```
npm run seed
```
Run the local server
```
npm run dev
```
## API Docs
Complete REST API Documentation can be found here
## License
> Copyright (C) 2024 Muhammad Habib Fery.
**[⬆ back to top](#mern-commerce-api)**
[Requirements]:#requirements
[Install]:#install
[How to setting]:#how-to-setting
[API Docs]:#api-docs
[License]:#license