/OC-Dev-JS-P12_SportSee-Front

🎓 OC PROJECT N°12: SportSee is a fake sports data UI.. GOAL=>Create a dashboard with react and a data visualisation library. +SKILLS: -mock an api with mirage -JSdoc -propTypes

Primary LanguageJavaScript

GitHub commit activity

Getting Started

To install dependencies run:

npm install

To run the project, you have 2 options:

Configuration in config.js

1. With a provisory backend by running:

npm start

You'll be connected with user 12(Karl) on http://localhost:3000

⚠️ Note that you should launch the backend micro api before by following the steps here: https://github.com/OpenClassrooms-Student-Center/P9-front-end-dashboard

2. With a mocked Api by running:

npm run mockedApi

You'll be connected with user 18(Cecilia) on http://localhost:3001

So, to run the app in development mode

If using provisory backend open http://localhost:3000 and if using mocked api http://localhost:3001 to view it in your browser. The page will reload when you make changes.
You may also see any lint errors in the console.

Also note that you can run both at the same time 👍

Docs

To generate jsdoc:

npm run generate-docs

Tests

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Build

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Eject

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.