Skip to content

Latest commit

 

History

History
203 lines (156 loc) · 5.72 KB

README.md

File metadata and controls

203 lines (156 loc) · 5.72 KB


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact
  7. Acknowledgments

About The Project

ECOM Screen Shot

(back to top)

Built With

List of frameworks/libraries used.

  • React
  • TypeScript
  • Bootstrap
  • Firebase
  • redux-toolkit

(back to top)

Getting Started

Prerequisites

  • npm
    npm install npm@latest -g
    Or
  • yarn
    npm install --global yarn

Installation


If you want to install and run the web app on your local machine you need to follow the instructions below
  1. Clone the repo
    git clone https://github.com/omidhzr/ecom
  2. Go to the project directory
    cd [to the directory that you have cloned the project in]
    cd ecom
  3. Install NPM packages
    npm install
  4. Run
    npm start
  5. Visit
    localhost:3000/

(back to top)

Usage

You can use the ECOM webshop like any other webshop.

In order to be able to put products to your shopping cart you need to sign up first.

You can remove or buy several of the same items in your shopping cart as well and pay via the most common payment methods such as Paypal, Stripe and Swish (WIP)

(back to top)

Roadmap

  • Add Home Page
  • Add Authentication
  • Add and retrieve Products to/from Firebase
  • Add Admin page to support adding and retrieval
  • Convert to Typescript
  • Add Dark Mode theme
  • Add Shopping Cart
    • a simple shopping cart to add and delete products from the home page
    • Add Checkout and Payment using Paypal / Stripe / Swish
  • Use redux for state management
  • Make a Proxy API using node express to call firebase admin sdk
    • protect the admin page using role based auth
  • Implement Lazy Loading
  • Write tests for components
  • Use Docker to host the Server
  • Restructure and Refactor the codebase
  • Add third-party SignIn process (via google)

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

LinkedIn

Email: [email protected]

Project Link: https://github.com/omidhzr/ecom

(back to top)

Acknowledgments

(back to top)