moultamissimane/amethyst-e-commerce

Amethyst is an ecommerce website to sell our products and it feature a catalog of products, a shopping cart system for selecting and purchasing items, and a payment gateway for processing transactions.

Amethyst

The best E-commerce store using Mern Stack with typescript

📔 Table of Contents

• About the Project
  • Tech Stack
  • Color Reference
  • Environment Variables
• Getting Started
  • Prerequisites
  • Installation
  • Running Tests
  • Run Locally
  • Deployment
• License

🌟 About the Project

👾 Tech Stack

Client

• Typescript
• React.js
• React Bootstrap
• Redux Toolkit

Server

• Typescript
• Node.js
• Express.js

Database

• MongoDB

🎨 Color Reference

Color	Hex
Primary Color	#FF6347
Secondary Color	#ffffff
Text Color	#222831

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

NODE_ENV JWT_SECRET MONGODB_URI PORT STRIPE_SECRET_KEY

‼️ Prerequisites

This project uses Yarn as package manager

 npm install --global yarn

⚙️ Installation

Install my-project with yarn

  yarn install my-project
  cd my-project

🧪 Running Tests

To run tests, run the following command

  yarn test test

🏃 Run Locally

Clone the project

  git clone https://github.com/moultamissimane/amethyst-e-commerce

Go to the project directory

  cd my-project

Install dependencies

  yarn 

Start the server

  yarn dev

⚠️ License

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