Skip to content

Latest commit

 

History

History
102 lines (63 loc) · 2.04 KB

README.md

File metadata and controls

102 lines (63 loc) · 2.04 KB
Raw

Maintainability Test Coverage

🛒 e-comm-team-axel25-fe

🗞️ About The Project

This is an e-commerce frontend app. It is built with React and Redux. It is a simple e-commerce app that allows users to view products, add them to cart, and checkout. It also allows sellers to add, edit, and delete products.

🍀 Tech Stack

  • React ⚛
  • TypeScript 🦕
  • Webpack 5 📦

🎆 Live Demo

Not yet live 🙂

💡 Getting Started

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

🚨 Prerequisites

  • Node.js
  • Package manager. We are using pnpm

If you are wondering why pnpm, take a look at why

🔩 Installation

  1. Clone the repo 🌀

    git clone https://github.com/atlp-rwanda/e-comm-team-axel25-fe

  2. Install packages 📦.

    pnpm install

  3. Rename the .env.example file to .env and fill in the required values

  4. Start your local development server 🌅

pnpm dev

🧪 Tests

  • A react component test sample
./src
   ├── /__tests__
   │   └── Toggle.spec.tsx
  • To run tests
pnpm test
  • To watch tests for changes and rerun
pnpm test:watch

🎨 Contributing

To make contributions...

  1. Clone the repo
  2. Create your Feature Branch (git checkout -b ft-some-feature)
  3. Commit your Changes (git commit -m 'ft: add some feature')
  4. Push to the Branch (git push origin ft-some-feature)
  5. Open a Pull Request

🪪 License

Distributed under the MIT License.

Acknowledgements

  • The Andela Team