https://github.com/the-blue-alliance/the-blue-alliance-pwa

A progressive web app for The Blue Alliance.
https://github.com/the-blue-alliance/the-blue-alliance-pwa

first-frc first-robotics-competition firstrobotics frc pwa robotics-competition the-blue-alliance

Last synced: 4 months ago
JSON representation

A progressive web app for The Blue Alliance.

• Host: GitHub
• URL: https://github.com/the-blue-alliance/the-blue-alliance-pwa
• Owner: the-blue-alliance
• License: mit
• Archived: true
• Created: 2019-06-02T00:15:56.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T02:30:39.000Z (almost 2 years ago)
• Last Synced: 2024-09-22T20:31:52.574Z (4 months ago)
• Topics: first-frc, first-robotics-competition, firstrobotics, frc, pwa, robotics-competition, the-blue-alliance
• Language: JavaScript
• Homepage: https://beta.thebluealliance.com
• Size: 2.35 MB
• Stars: 14
• Watchers: 8
• Forks: 6
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The Blue Alliance Progressive Web App (PWA)

[![Actions Status](https://github.com/the-blue-alliance/the-blue-alliance-pwa/workflows/On%20push/badge.svg)](https://github.com/the-blue-alliance/the-blue-alliance-pwa/actions)

[![Coverage Status](https://img.shields.io/codecov/c/github/the-blue-alliance/the-blue-alliance-pwa/master.svg)](https://codecov.io/gh/the-blue-alliance/the-blue-alliance-pwa/branch/master)

A universally (server + client) rendered React PWA for The Blue Alliance.

Currently at https://beta.thebluealliance.com

## Getting started

[Node.js](https://nodejs.org/en/download/) 10 is required.

[NVM](https://github.com/nvm-sh/nvm) can be used to manage Node.js versions.

Fill out `.env.sample` and save it as `.env`.

`npm install` to install packages.

`npm run dev` to run the app in development mode at [http://localhost:3000](http://localhost:3000).

`npm run prettier` to run formatting checks.

`npm run lint` to run lint checks.

`npm run test` to run all tests.

`npm run test:watch` to run tests in watch mode to run tests related to changed files every time a file is saved.

`npm run analyze` to analyze bundle size.

`npm run build` to build for production.

`npm run deploy` to deploy to production.

`npm start` to run the production server at port 3001 (or a specified PORT).

## Developer notes

We use [Husky](https://github.com/typicode/husky) to manage Git hooks.

In particular, Prettier and ESlint are used to format and lint code during pre-commit.

We recommend installing text editor plugins for [Prettier](https://prettier.io/docs/en/editors.html) and [ESlint](https://eslint.org/docs/user-guide/integrations) to automatically format code and warn about any

errors during development.

## Made with

- [React](https://github.com/facebook/react)

- [Next.js](https://github.com/zeit/next.js)

- [Material UI](https://github.com/mui-org/material-ui)