Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hughmorris01/proshop
This is an e-commerce web application built using MERN stack. It's deployed to a free tier on render.com which may take a minute to wake up, please be patient.
https://github.com/hughmorris01/proshop
express mongodb node react
Last synced: about 1 month ago
JSON representation
This is an e-commerce web application built using MERN stack. It's deployed to a free tier on render.com which may take a minute to wake up, please be patient.
- Host: GitHub
- URL: https://github.com/hughmorris01/proshop
- Owner: HughMorris01
- Created: 2023-06-12T11:20:19.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-13T00:19:41.000Z (about 1 year ago)
- Last Synced: 2023-12-14T01:53:58.643Z (about 1 year ago)
- Topics: express, mongodb, node, react
- Language: JavaScript
- Homepage: https://proshop-usrw.onrender.com
- Size: 2.45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ProShop eCommerce Platform
> eCommerce platform built with the MERN stack & Redux.
- [Features](#features)
- [Usage](#usage)
- [Env Variables](#env-variables)
- [Install Dependencies (frontend & backend)](#install-dependencies-frontend--backend)
- [Run](#run)
- [Build & Deploy](#build--deploy)
- [Seed Database](#seed-database)
* [License](#license)
## Features
- Full featured shopping cart
- Product reviews and ratings
- Top products carousel
- Product pagination
- Product search feature
- User profile with orders
- Admin product management
- Admin user management
- Admin Order details page
- Mark orders as delivered option
- Checkout process (shipping, payment method, etc)
- PayPal / credit card integration
- Database seeder (products & users)
## Usage
- Create a MongoDB database and obtain your `MongoDB URI` - [MongoDB Atlas](https://www.mongodb.com/cloud/atlas/register)
- Create a PayPal account and obtain your `Client ID` - [PayPal Developer](https://developer.paypal.com/)
### Env Variables
Rename the `example.env` file to `.env` and add the following
```
NODE_ENV = development
PORT = 5000
MONGO_URI = your mongodb uri
JWT_SECRET = 'abc123'
PAYPAL_CLIENT_ID = your paypal client id
PAGINATION_LIMIT = 8
```
Change the JWT_SECRET and PAGINATION_LIMIT to your preferences
### Install Dependencies (frontend & backend)
```
npm install
cd frontend
npm install
```
### Run
```
# Run frontend (:3000) & backend (:5000)
npm run dev
# Run backend only
npm run server
```
## Build & Deploy
```
# Create frontend prod build
cd frontend
npm run build
```
### Seed Database
You can use the following commands to seed the database with some sample users and products as well as destroy all data
```
# Import data
npm run data:import
# Destroy data
npm run data:destroy
```
```
Sample User Logins
[email protected] (Admin)
123456
[email protected] (Customer)
123456
[email protected] (Customer)
123456
```
---
## License
The MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.