README.md

eShop Management Dashboard

eShop is an e-commerce tool used to sell goods online

This repo holds code for the management dashboard of eShop

Table of contents

• Tools
• Setup
• To install dependencies run
• Set environment variables
• Running tests
• Starting local development server

Tools

• Node - A Javascript runtime environment.
• React - A Javascript library for building user interfaces.
• Next - A React framework for the web.
• Redux/Redux Toolkit - A Javascript library for predictable and maintainable global state management
• Tanstack Query - Powerful asynchronous state management library
• NPM - A package manager

Setup

Clone the repository:

git clone https://github.com/Qadriyah/eshop-dashboard.git

Then change to project directory:

cd eshop-dashboard

To install dependencies run:

npm install

This will install all the dependencies defined in the package.json file inside the eshop-dashboard folder.

Set environment variables

Be sure to set the environment variables shown in the .env.local.example file

Running tests

To run unit and integration tests:

npm test

To generate the test coverage report:

npm run test:coverage

To run e2e tests

npm run cy:open

Starting local development server

With docker

TODO

Without docker

npm run dev

After starting the local development server, application can be accessed at:

localhost:3000