Peregrine

Peregrine is a HTTP JSON API written in Go for scouting and analysis of FIRST Robotics competitions.

For a description of what scouting is, please view the SCOUTING.md.

Setup

1. Install Git and Go (1.14)

2. Clone the repo:

git clone git@github.com:Pigmice2733/peregrine-backend.git

4. Change directory to the repo root:

cd peregrine-backend

5. Install PostgreSQL and start the server.

6. Install the peregrine binary:

NOTE: If you cloned the repo to somewhere in your GOPATH (e.g. with go get) you'll need to export GO111MODULE=on.

go generate ./... # neccessary to compile OpenAPI documentation into the binary
go install ./...

7. Create the peregrine database:

createdb -U postgres peregrine

8. Copy the config template:

cp template.json config.json

9. Modify config.json as neccesary. You will likely not need to change anything besides the TBA API key and the JWT secret if you followed the instructions here. You will need to go to the TBA account page and get a read API key and set apiKey under the tba section to the read API key you register. Set the JWT secret to the output from uuidgen -r.

10. Download golang-migrate and run the database migrations:

migrate -database "postgres://postgres@localhost:5432/peregrine?sslmode=disable" -path "$(pwd)/migrations" up

11. Run the app:

peregrine config.json

API Documentation

Peregrine's entire API is documented with OpenAPI 3.0.0 (previously known as Swagger). You can view the documentation here. If you notice any inaccuracies please let us know so the documentation can be corrected.

Testing

go test -v ./...

Contributing

1. Create a branch with a name that briefly describes the feature (e.g. report-endpoints):

git checkout -b report-endpoints

2. Add your commits to the branch:

git add internal/foo/bar.go
git commit -m "Add the initial report endpoints"

3. Verify that your tests pass (see the testing section). If they don't then fix them and add a commit.

4. Push the branch to the remote github repo:

git push -u origin report-endpoints

4. Visit the project on Github, go to Pull Requests, and hit New Pull Request.
5. Fill out the template.
6. Assign relevant reviewers, assign yourself, add any applicable labels, assign any applicable projects, and hit Create Pull Request.