https://github.com/frc2052/frc-krawler
FIRST Robotics scouting app brought to you by Team 2052
https://github.com/frc2052/frc-krawler
first frc frc-krawler robotics-scouting
Last synced: 4 months ago
JSON representation
FIRST Robotics scouting app brought to you by Team 2052
- Host: GitHub
- URL: https://github.com/frc2052/frc-krawler
- Owner: frc2052
- License: mit
- Created: 2015-06-15T15:17:45.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2025-01-27T18:25:18.000Z (over 1 year ago)
- Last Synced: 2025-01-27T18:29:11.691Z (over 1 year ago)
- Topics: first, frc, frc-krawler, robotics-scouting
- Language: Kotlin
- Homepage:
- Size: 173 MB
- Stars: 24
- Watchers: 16
- Forks: 24
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# FRC Krawler
[
](https://play.google.com/store/apps/details?id=com.team2052.frckrawler&hl=en)
FRC Krawler is a *FIRST* Robotics Competition scouting app developed by Team 2052 - KnightKrawler.
## Issues using the app?
Please feel free to open feature requests and bug reports here on GitHub! We'll do our best to
address them in a timely manner.
## Project setup
You will need to set up some project secrets to properly build this project.
### TBA API Key
Update your `local.properties` file with the following:
* `frckrawler.tba-api-key`: [An auth key for The Blue Alliance](https://www.thebluealliance.com/apidocs)
```
frckrawler.tba-api-key=abc123
```
### Firebase configuration (optional)
This repo includes a fake Firebase configuration file, and you should be able to run the app as-is.
If you want to test Firebase integration, you will need to replace the default configuration file
with a real one.
Set up a Firebase project and [follow steps 1 & 2 here](https://firebase.google.com/docs/android/setup?authuser=1&hl=en#console) to add an Android app to your project.
Follow the instructions in step 3 to download the `google-services.json` file and replace the one in this project at `app/google-services.json`.
## Building documentation site
Our docs site is published using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
To get started, install python. Then run:
```shell
python3 -m venv venv
source venv/bin/activate
pip install mkdocs-material
mkdocs serve
```