Squiddymabob / nhl-app

πŸ’ A React application that presents various information about the NHL via official, yet undocumented, APIs.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

πŸ’ React App Using NHL API

A React application that presents various information about the NHL via official, yet undocumented, APIs.

πŸ₯… Goals

  • Tackle challenge of using undocumented a APIs.
    • Some community documentation available but none officially for any of the APIs used.
    • Documentation available for the NHL Records and Stats APIs here by Drew Hynes.
  • Improve React skills.
    • Learn React libraries such as React Router.
    • Learn React Redux.
  • Improve Bootstrap skills.
  • Learn styling using Sass.
  • Improve UI design skills.
  • Improve UX skills by making sure there is clear flow between components.
  • Have fun with available NHL data from the APIs!

πŸ’» Technologies Used

  • React
  • Bootstrap
    • This project uses Bootstrap v5.0.0-apha1.
    • The alpha was chosen as to learn and explore it's new features in a project that did not require stability for real deployment.
  • React Router
  • React Redux
  • SASS
  • Axios

πŸ–₯️ APIs Used

πŸ“„ Running the Project

In the project directory, you can run:

npm start

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

npm test

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

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.
The app is now deployable.

See the section about deployment for more information.

βš–οΈ License

This project is licensed under the MIT License.

This project is not affiliated with the NHL in any way.

NHL and the NHL Shield are registered trademarks of the National Hockey League Β© NHL 2020. All Rights Reserved.

About

πŸ’ A React application that presents various information about the NHL via official, yet undocumented, APIs.

License:MIT License


Languages

Language:JavaScript 87.3%Language:CSS 7.1%Language:HTML 5.6%