Build an analytics dashboard with react

Project description

This project is part of OpenClassrooms "Développeur d'application - JavaScript React" training.

The goal of this project is to create a user dashborad using Recharts and the provided API. The backend was provided and its documentation are available in this github repository.

User Stories are available here. Figma file was provided here.

🔗 Online Deployment

🛠 Tech Stack

Badges

Run Locally

1. Prerequisite

• NodeJS (version 12.18)
• Yarn

It is highly recommended to use nvm in order to switch easily NodeJS version. Indeed, this project uses Vite and Vite requires Node.js version 14.18+, 16+.

2. Installation

First of all, clone this repo on your computer

git clone https://github.com/EPourmo/build-an-analytics-dashboard-with-react.git

2.1 Back end

Go to the back end folder and install all dependencies

npm install

or

 yarn install

Then run the script

npm run dev

or

 yarn run dev

The data is accessible at http://localhost:3000/. For example, to have user 18 main data, you can have access with http://localhost:3000/user/18.

2.1 Front End

After running the back end, go to the front end folder and install all dependencies

npm install

or

 yarn install

Then run the script

npm run dev

or

 yarn run dev

The front end data will be accessible at the localhost logged on your terminal.

Features

• Dashboard
• Reacharts
• Reusable components