Skip to content

Latest commit

 

History

History
55 lines (28 loc) · 1.16 KB

File metadata and controls

55 lines (28 loc) · 1.16 KB

Contributing

Set up the prerequisites.

Check out design to learn how the existing stuff works.

Check out design plans to see what needs work.

Add yourself to contributors if you work on something.

Tech Stack

Golang used for the REST API server. Check out the notable packages.

Postgresql used for the DB.

Docker and docker-compose used for containerization.

Google for Oauth2 authentication.

Make for commands. See Makefile.

Python for containerized integration tests.

Mock-server for containerized mock authentication server.

Python mock-server client for setup between integration tests and mock authentication server.

Running

Running anything outside of Docker, such as unit tests, will require running make fetchdeps first.

Start or stop the db and server:

make up

make down

Restart only the server (useful for code changes):

make reapp

Testing

Unit tests:

make test

Integration tests (detailed info at integration tests):

make inttests

Others:

make fmt lint vet