/proshop

A full stack eCommerce site written from scratch in TypeScript using the MERN stack.

Primary LanguageTypeScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

ProShop

Full Stack E-commerce Store
Report Bug · Request Feature

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

About The Project

This is an example eCommerce store using full stack MERN and TypeScript. Built out here from scratch to be used by myself or anyone interested in spinning up custom eCommerce stores without the need of something like squarespace or shopify. A educational exercise for myself.

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo 
    git clone https://github.com/luke-pritch/proshop.git
  2. Install NPM packages in both the back end and front end 
    cd backend && npm install
cd ../frontend && npm install

Usage

More details will be added here as the project is still in active development.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Luke Pritchard - lp@lukepritchard.ca

Project Link: https://github.com/luke-pritch/proshop