https://github.com/ant-throw-pology/2898-scouter
An FRC scouting app made by Team 2898
https://github.com/ant-throw-pology/2898-scouter
2898 frc scouter
Last synced: about 1 month ago
JSON representation
An FRC scouting app made by Team 2898
- Host: GitHub
- URL: https://github.com/ant-throw-pology/2898-scouter
- Owner: Ant-Throw-Pology
- Created: 2024-12-21T21:05:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-08T06:07:56.000Z (about 1 year ago)
- Last Synced: 2025-03-08T06:27:10.125Z (about 1 year ago)
- Topics: 2898, frc, scouter
- Language: TypeScript
- Homepage: https://ant-throw-pology.github.io/2898-scouter/
- Size: 435 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 2898 Scouting App
> We are not affiliated with FIRST or FRC. **You** are responsible for following all rules when using this program. The developers of this program are **NOT** responsible for any rules broken during use of this program.
A scouting app written in HTML, CSS, and TypeScript by members of FRC team 2898.
Try the app here: https://ant-throw-pology.github.io/2898-scouter
## Installing
### 64-bit macOS, Linux, Windows, or Crostini
An installer is available (for Linux, macOS, Windows, Crostini/ChromeOS Linux Mode) which will install the app to your computer: https://github.com/droid-kk11/2898-scouter-installer
### "Installing" on Chrome OS, or other systems unsupported by the installer
To install on Chrome OS, download scouter.zip from [the latest scouter release](https://github.com/Ant-Throw-Pology/2898-scouter/releases/latest), unzip it, and run it from a memorable location. (Until a ChromeOS installer is created).
## Contributing
We use [Bun](https://bun.sh/) as our build system.
To install dependencies:
```bash
bun install
```
To run, build the TypeScript:
```bash
bun run build
```
To continuously build when a file is changed (recommended when coding):
```bash
bun run build --watch
```
Then, open `build/index.html` in your web browser or serve the `build` directory with a file server.
This must be run every time you make a change. If you want `bun` to continuously check for changes, instead run:
```bash
bun run build --watch
```
### Adding an asset
* [ ] Add the asset under the `src` directory
* [ ] Import the asset in `index.ts`:
```ts
import "./asset.png" with {type: "file"};
```
* [ ] Add the asset to the list of cached resources in `serviceworker.ts`