Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/code9g/sportsee

Projet 12 de la formation "Développeur JavaScript / React" de OpenClassRooms
https://github.com/code9g/sportsee

css3 html5 javascript react react-router-dom recharts sass vitejs

Last synced: about 2 months ago
JSON representation

Projet 12 de la formation "Développeur JavaScript / React" de OpenClassRooms

Awesome Lists containing this project

README

        

# SportSee

![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)
![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)
![recharts](https://img.shields.io/badge/recharts-22b5bf?style=for-the-badge)
![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white)
![JSdoc](https://img.shields.io/badge/jsdoc-006fbb?style=for-the-badge)
![BetterDocs](https://img.shields.io/badge/better--docs-008b64?style=for-the-badge)

Projet 12 du parcours "**Développeur d'application - JavaScript React**" chez [OpenClassroom](https://openclassrooms.com/fr/).

## Description

Développez un tableau de bord d'analytics avec React

![Screenshot](./images/profil.png)

Vous travaillez en tant que développeur chez SportSee, une startup dédiée au coaching sportif. En pleine croissance, l’entreprise va aujourd’hui lancer une nouvelle version de la page profil de l’utilisateur. Cette page va notamment permettre à l’utilisateur de suivre le nombre de sessions réalisées ainsi que le nombre de calories brûlées.

## Installation

Ce projet a été testé et réalisé avec la version 20.15.1 de Node.js

### Partie Back

Cette partie utilise de préférence yarn, cependant, vous pouvez également le faire avec npm, ou passer par docker (pour cela je vous recommande de suivre le [README](./back/README.md#3-project-with-docker) du back).

Installer les dépendances :

```
cd back
yarn
```

Lancer le back :

```
cd back
yarn start
```

### Partie Front

Dans un nouveal terminal :

```
cd front
npm install
```

Et lancer le projet avec :

```
npm run dev
```

## Lancement

Si vous avez déjà installé les dépendances, vous pouvez directement lancer la partie back et la partie front depuit la racine du projet avec :

```
npm run back
```

et

```
npm run front
```

## Documentation

La documentation a été réalisé en utilisant la syntaxe de jsdoc, permettant à la fois d'être directement lisible par Visual Studio Code,
qui affiche un tooltip lorsque la souris passe sur un élément avec une documentation jsdoc, mais également de générer "automatiquement"
un document html.

La documentation est accessible [ici](https://code9g.github.io/SportSee/)

[![Github Pages](https://img.shields.io/badge/github%20pages-121013?style=for-the-badge&logo=github&logoColor=white)](<[http://](https://github.com/code9g/)>)
[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/pierre-andre-henry/)