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.
git clone firstname.lastname@example.org:Pigmice2733/peregrine-backend.git
- Change directory to the repo root:
Install PostgreSQL and start the server.
NOTE: If you cloned the repo to somewhere in your GOPATH (e.g. with
go get) you'll need to
go generate ./... # neccessary to compile OpenAPI documentation into the binary go install ./...
- Create the postgres database:
createdb -U postgres peregrine
- Copy the config template:
cp etc/config.yaml.template etc/config.development.yaml
etc/config.development.yamlas neccesary. You will likely not need to change anything besides the TBA API key if you followed the instructions here. You will need to go to the TBA account page and get a read API key and set
tbasection to the read API key you register.
- Run the database migrations:
- Run the app:
Peregrine's entire API is documented with OpenAPI 3.0.0 (previously known as Swagger). You can view the documentation here, or by running peregrine locally and going here. If you notice any inaccuracies please let us know so the documentation can be corrected.
Peregrine has both unit tests and integration tests. Both should be passing for a new feature.
Run go test:
go test ./...
Integration (jest) tests
You must have a server running for integration tests. See the setup section.
- Go to the api-tests folder:
- Install dependencies:
- Set the
GO_ENVenvironment variable if you used Docker to setup the app:
- Run the tests:
- Create a branch with a name that briefly describes the feature (e.g.
git checkout -b report-endpoints
- Add your commits to the branch:
git add internal/foo/bar.go git commit -m "Add the initial report endpoints"
Verify that your tests pass (see the testing section). If they don't then fix them and add a commit.
Push the branch to the remote github repo:
git push -u origin report-endpoints
- Visit the project on Github, go to Pull Requests, and hit New Pull Request.
- Fill out the template.
- Assign relevant reviewers, assign yourself, add any applicable labels, assign any applicable projects, and hit Create Pull Request.