Pinpoint is a membership application management service geared towards helping university clubs and hackathons decide on the best applicants out of their pool of candidates.
See the project outline and minimum viable product in our wiki.
The project is structured as follows:
coreis the primary Pinpoint gRPC-based service, and manages application logic and the database.
frontendis the Pinpoint web application.
gatewayis an HTTP server that exposes Pinpoint functionality via a RESTful API.
protobufcontains protobuf definitions for Pinpoint Core's gRPC service as well as the generated Golang API.
utilsis a Golang package that contains utility functions shared by
To get started, make sure you have the following installed:
To fetch the codebase, use
$> go get github.com/ubclaunchpad/pinpoint
$> make deps
$> make pinpoint-core $> make pinpoint-gateway
$> make web
Spinning up Services Locally
External dependencies, such as the database, can be started and stopped using docker-compose, which leverages available Docker containers:
$> make testenv # start up service containers $> make testenv-stop # stop containers $> make clean # remove containers
Pinpoint services can be started up using the following commands in two separate shell sessions:
$> make core $> make gateway
By default, provided certificates in
dev/certs are used. These were generated using certstrap.
To run enable the local monitoring suite:
$> make monitoring $> make core FLAGS=--logpath=tmp/core.log $> make gateway FLAGS=--logpath=tmp/gateway.log
Updating the Golang gRPC API
core uses the Golang API within the
protobuf directory to communicate. If you make changes to the protobuf definitions in the
protobuf directories, you will need to update this API:
$> make proto # generate new Golang API $> make check # ensure everything compiles
The script also uses counterfeiter to generate mocks.