Skip to content
BOSS Leaderboard and Claims API and website
Branch: master
Clone or download
Latest commit 7d37478 May 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
assets close boss Aug 15, 2017
audit keep audit May 20, 2017
auth auth/passportStatergies.js: Fixed typo in filename May 15, 2018
db/migrations fix typo in db table name May 28, 2017
public_static
routes
semantic/src update submodule Jul 30, 2018
test
utils
views Merge pull request #184 from mansiagarwal451/update_lobby May 21, 2019
.gitignore remove hardcoded credentials Sep 30, 2018
.gitmodules
.prettierrc
README.md
config.js
index.js Add Tests Aug 15, 2017
package-lock.json Merge branch 'master' into escape_html Sep 29, 2018
package.json
secrets-sample.json
semantic.json
server.js
yarn.lock ready for boss 2019 May 4, 2019

README.md

Total alerts Language grade: JavaScript

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • NodeJS
  • Node Package Manager(NPM)
  • Git
  • PostgreSQL

Installing

A step by step series of examples that tell you have to get a development environment running

  1. Download ZIP file or clone the repository to create your own copy.
git clone https://github.com/coding-blocks/boss.git

  1. Move to the boss repository
cd ./boss

  1. Install all project dependency packages via NPM
npm install

  1. Create a secrets.json file in the root directory taking hint from the secrets-sample.json file or You can also create a copy of secrets-sample.json file and rename it as secrets.json in the root directory. ( Don't worry secrets.json is already added to .gitignore file so it won't be commited )

  2. Create a Client on Coding Blocks OneAuth using https://account.codingblocks.com/clients/add

Remember the Client ID and Client Secret and copy them to your secrets.json file.

Also, remember to change the callback URL to your desired url. You can use http://localhost:3232/login/callback if you are testing on your localhost system.

  1. Set up PostgreSQL
  • If you don't have PostgreSQL setup on you machine you can download it from here.
  • If you have renamed the secrets-sample.json file to secrets.json then
    • After Installation is complete create a new PostgreSQL user username with password as pass.
    • Create a new database in PostgreSQL server with name dbname.
  • If you have created a new secrets.json file then create the respective things accordingly.
  1. Start the server.
npm start

And see it working on http://localhost:3232

For Testing

BOSS_DEV=localhost node index.js

API

CLAIMS

List All Claims

GET /api/claims?[status=accepted]

Add a claim

POST /api/claims/add
BODY
{
  user: "championswimmer",
  issueUrl: "http://github.com/coding-blocks/lab/issues/7",
  pullUrl: "http://github.com/coding-blocks/lab/pull/7",
  bounty: 20
}

You can’t perform that action at this time.