Project 12 SportSee

This repo contains all the source code to run the application for the sports analytics SportSee.

1. General information

To start this project, You have to fork and clone the repository backend (https://github.com/OpenClassrooms-Student-Center/P9-front-end-dashboard.git) for to run the micro API for the sports analytics dashboard SportSee. There is all the information concerning the installation of backend part in file README.

2. Project

2.1 Prerequisites

• NodeJS (version 12.18)
• Yarn
• axios (**version ^0.27.2)

2.2 Launching the project

• Fork the repository (https://github.com/marinasatsyk/DARDEMarina_P12_18032021.git)
• Clone it on your computer.
• The npm i or yarn command will allow you to install the dependencies.
• The npm start for backend part and npm start for frontend part command will allow you to run the the application. .

Runs the app in the development mode. Open http://localhost:3002 to view it in your browser.

The page will reload when you make changes.

2.3 Documentation

• Install [JSDoc] (https://www.npmjs.com/package/jsdoc)
• For starting: npm run jsdoc , then open index.html from jsdoc folder with live-server.