/arbitrium

This platform allows organizations to judge user-submitted applications on a large scale. Used for funding rounds and other decision making activities.

Primary LanguageJavaScriptOtherNOASSERTION

Getting Started (Contributors Only)

  1. Clone the repo
  2. Grab the secrets
  3. run ./scripts/firstTimeSetup.sh (see "Available Scripts" for more info)
  4. run the backend and frontend
    • same terminal: run npm run dev
    • separate terminals: run npm start in one terminal (frontend) and then cd backend/ and then run node server.js for the backend

About Arbitrium

This web app (Arbitrium) is a review tool built for non-profit organizations. It is used to help non-profits make decisions on how to allocate grant funding and currently has a 3 part-process:

  1. The non-profit releases an application and Arbitrium collects the responses
  2. A group of reviewers, usually community leaders, picked by the non-profit are then asked to rate and rank the applications
  3. Arbitrium provides dashboards to visualize the review rate, the average rating and the average ranking of each application

Team

Project Lead: Greg Maxin
Product Manager: Brittany Lau
Senior Developers: Xin Hao Zhang, Sherry Li, Hyunzee Kim, Ahmed Hamodi

Usage Stats

Usage

  • 283 Applications Submitted
  • 1516 Review Done
  • 71 Users
  • 9 Grant Application Rounds Supported
  • $2M+ in Funding

Local Development Setup

Frontend and backend

In the project directory, you can run:

npm run dev

This runs the frontend and backend in development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits.

Backend only

To run the backend server:

cd backend
nodemon server.js

To call any APIs that require authentication without the frontend running (ex. using curl or Postman), you'll need an access token. You can generate a token for your account this with the command:

./scripts/getFirebaseToken.sh {email} {password}

This script will output a JSON object – you can use the idToken value and provide it as a bearer token to your API calls. This token expires every hour, and you can rerun this script to generate a new one.

Deployment

chmod u+x "scriptname" (This will give you execute permissions for the script)

./scripts/deploy.sh

Builds the app and stores it in the /build folder The build is then uploaded/deployed to firebase https://decision-io.firebaseapp.com/

./scripts/firstTimeSetup.sh

Installs nodejs and npm Installs/Updates all npm modules outlined in package.json for the project in the current directory