Git Product home page Git Product logo

pinpoint's Introduction

๐Ÿ“Š pinpoint Build Status codecov Go Report Card

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.

Project Structure

The project is structured as follows:

  • client is the JavaScript client for the user-facing Pinpoint API.
  • core is the primary Pinpoint gRPC-based service, and manages application logic and the database.
  • frontend is the Pinpoint web application.
  • gateway is an HTTP server that exposes Pinpoint functionality via a RESTful API.
  • grpc is a Golang package for Pinpoint Core's gRPC service, generated from protobuf definitions.
  • protobuf contains protobuf definitions for Pinpoint Core's gRPC service.
  • utils is a Golang package that contains utility functions shared by core and gateway.

Development

To get started, make sure you have the following installed:

To fetch the codebase, use go get:

$> go get github.com/ubclaunchpad/pinpoint

Installing Dependencies

You will need dep and npm installed.

$> make deps

Spinning up Services Locally

Run the following commands in two separate shell sessions:

$> make core
$> make gateway

Updating the Golang gRPC API

gateway and core uses the Golang API within the grpc directory to communicate. If you make changes to the protobuf definitions in the protobuf directories, you will need to update this API:

$> make proto

You will need protobuf v3.6+ and the Golang plugin installed.

pinpoint's People

Contributors

bobheadxi avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.