Embossed React Ecommerce

An ecommerce project built with the MERN stack.

Client Demo Hosted on Netlify · Dummy Data Admin Repo · My LinkedIn

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Related Project
6. Contact

About The Project

The Embossed React Ecommerce app is an online shopping app built with the MERN stack. There are three directories in the project's root directory: client, admin and server.

The client app will be the one users will be using to browse for and add products to carts.

The admin app is only accessible to users with admin creds and serves as the dashboard where shop user, product, category, cart and sale data can be created, updated and deleted.

The client and admin apps use the same server for interacting with the project's MongoDB database.

Check out the Embossed admin demo dashboard repo that uses dummy data instead of MongoDB data.

Check out the client demo hosted on Netlify to explore the shop.

(back to top)

Built With

• MongoDB
• Express.js
• React.js
• Node.js
• Bootstrap

(back to top)

Getting Started

Below you'll find some instructions on what you'll need to run the project locally on your machine, how to install the app and how to get the app running.

Prerequisites

• npm

  npm install npm@latest -g

Installation

Before you run the admin or client Embossed apps locally, you'll need to install their required dependencies.

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Navigate to the desired directory.

   cd client

   or

   cd admin

   or

   cd server

3. Install NPM packages for each directory.

   npm install

4. Rename the .env.example file in the client and server directories to .env

(back to top)

Usage

Both the client and admin app use the same server to interact with this project's MongoDB database.

1. Start the client or admin app locally.

   npm start

2. Navigate to the the server directory and start the server with the same command.

   npm start

(back to top)

Roadmap

• Implement planned CRUD functionality.
• Include server directory to repo.
• Add navbar search functionality.
• Introduce option to apply sales to more than one product or to all products within a category.
• Execute get requests using Redux for products and sales.

(back to top)

Related Project

The Embossed admin dashboard hosted on Netlify is a version of the app that uses dummy data rather than MongoDB data. You can check out that project's GitHub repo here.

(back to top)

Contact

Andrew Fleming - My LinkedIn - aflemi1@gmail.com

(back to top)