coding-blocks / boss Goto Github PK

BOSS Leaderboard and Claims API and website

Home Page: https://boss.codingblocks.com

JavaScript 47.87% CSS 0.82% Shell 0.23% Handlebars 51.08%

boss coding-blocks open-source nodejs postgresql

boss's Introduction

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

Download ZIP file or clone the repository to create your own copy.

git clone https://github.com/coding-blocks/boss.git

Move to the boss repository

cd ./boss

Install all project dependency packages via NPM

npm install

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 )
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.

Set up PostgreSQL

If you don't have PostgreSQL setup on your 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.

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
}

boss's People

Contributors

Stargazers

Watchers

Forkers

abhishek97 ghoomtaaaina shubhsingh594 astu9880 mukulsaini prateekiiest vatsalgarg1617 akansh97531 arushisinghal shipragupta14 ashishkrgoyal mputlesn suesanz adityac8 iamravitejag-zz arvindkalra bhavyaagg ananay architkshk thenamankumar kevalvc s2606 nischaljakhar sudonitesh nshul pratyush1687 adityahirapara vibhorgupta-gh till-tomorrow dhroov7 venomousboxer mohitj27 ashishsainiu2 keenwarrior atmanandsah asim1996 niharika-arora goyal-dushi goelvineet coderaryan doshirishabh26 pwnsoni gamemma varun4uone amanagrw shubhamrwt shanky199912 zoovier20 mohitseth sameerchoubey nationlover rishirwt krishbht15 rawat1234 syedfaisaljaved coolcodernd malik-gaurav rahulbudhraj swisspun shikharsaxena999 jainlovelish3 sagarkr1729 dsdsharma op8427152885 sharmavedant17 singhlakhjindar abhiverma1924 ravikumarranjan86 lakshyak13 avniavi ashwarrior nikhiltiwari507 ritvik2708 uniqueshah rhytham muskaangupta1 vlover utkarshvikramsingh lazy-god firefinchdev mitansha jatinkatyal13 criticic mansiagarwal451 dpmittal abhisheksingh98 sourabh1031 rajshah9914 sachin235 jaskeerat789 urvashigupta7 farhan787 sgpritam imdhruvgupta mritunjaysharma394 chtushar rishipurwar1 anuragsinghjadon yashkumarverma arpitv424

boss's Issues

Support error handling in responses

Currently, if some error occurs with the api request, the request waits for timeout to occur, that's not good.

So I propose we should return some error to describe the failure.

ERROR: Cannot get CLAIMS ADD Page

add sort by project name (in issue url)

Keeping this open you can add either

filter by project
a search box where we can search project name

You can make it on frontend as a live filter, or make make the search as a rest query and make the backend send fresh list of claims which fulfill the search param

[Feature] The participant name should redirect to his/her # of contributions in BOSS

currently, the participant name is not redirecting anywhere. Make it redirect to the page where his/her contribution details can be found.

In reference to issue #49

add login with oneauth support, add roles

there should be roles and users
users can login via oneauth
users with admin role can edit claims. others cannot
if github information is available from oneauth, add github username automatically to claim add form

Side menu bar icon does not works

does not works in mobile view
in reference to issue #49

Error adding claim

This happens after i logged in via github account
@championswimmer Please help

GET /api/claims is incorrect

@championswimmer Sir /api/claims does not return the required data. It returns an empty array.

Validate Github username when adding claim

The github username accepts anything as of now. It should use github api to check if a username exits or not.

[Bug Report] Tests aren't running properly

Add a readme on how to set up this project and contribute

While i was trying to resolve an issue, I found that there are no proper Getting Started instructions to begin working on this project.
I had to personally set up the database using PostgreSQL. (There is no mention in the Readme.md of this project like there is in the shortlr project)
I had to hardcode a workaround the required oneauth authorisation because if you attempt to authorise the localhost then callback URL doesn't match
If you are working on issue related to claims, then claims are added wrt the username of the github handle used in oneauth, so basically hardcode that too..

I don't know if there was any other proper method to start on the project. Any suggestions would be helpful for others who want to begin contributing to this project.

add tests for the db and apis

When clicking on "Open Issues" on Chrome browser then it is redirecting to error page "https://github.com/issues?utf8=%E2%9C%93&q=is:open%20is:issue%20label:BOSS%20org:coding-blocks"

[Bug Report] Next Button on Accepted and Rejected claim page not working

The NEXT button while viewing Accepted and Rejected Claims ( here:https://boss.codingblocks.com/claims/view?status=accepted and https://boss.codingblocks.com/claims/view?status=rejected) , is redirecting to the claimed ones.

text overflow on login buttons

See the login link texts

In reference to issue #49

There should be a button on Leaderboard to go directly to BOSS homepage.

Bug:Claims button in navBar not working in mobile

404 on boss github issues link in navbar

issues page showing 404 if the person is not logged in to github already

sort claims in /claims/view page in decreasing order of modifiedAt

Text out of mobile screen

In reference to #49

add pagination to /claims/view page

make a page about this project on lab.codingblocks.com

check for reference how to add a new project - coding-blocks/lab.codingblocks.com#7

[Enhancement] External links should open in new tab

A couple of links in header other than boss site should open in new tab if clicked.

Information
Open issues
Gitter

Responsiveness

(working on this)
@championswimmer

when submitting claim, ignore spaces to right or left of username

spaces might come in the form field by error. ignore spaces on left or right of username on form submission

NOTE: solve it in the backend. not using frontend validation

[enhancement] add contribution guidelines on homepage

Next Button Not disabled

As we browse the leaderboard as the leaderboard ends the next button should be disabled but currently it takes us to a blank page with just the table headers

Last Page:

After the last page on clicking on Next(which should have been disabled at end of leaderboard):

allow editing the bounty points

for admins only
when editing claims (to change status)
also add feature to change claims amount

Add responsiveness (mobile site)

I think even the meta tags are not set. I could work on that. Referencing #49

add an item on the navbar for showing open issues

link to all open issues for BOSS =
https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3ABOSS+org%3Acoding-blocks or

https://github.com/issues?utf8=✓&q=is:open is:issue label:BOSS org:coding-blocks

GET /api/claims/:id/update is not working properly

when rejecting claim, allow adding an explanation message

Typo: auth/passportStatergies.js

The script has been named passportStatergies.js has a typo (strategies, and not statergies), and has been further used inside the file server.js here: https://github.com/coding-blocks/boss/blob/master/server.js#L8

New issue filed.
@championswimmer Please approve as per issue #49.

API throws an error when adding a claim without a PR URL

Claims need to be submitted for only opening issues as well. Since they do not include a PR URL, the application should allow the PR URL field to be left blank.

a) In the case of "/api/claims/add", the server throws an error (shown below)
b) In the case of "/claims/add", the request "freezes up", doesn't add the claim and then cloudflare sends the thing shown below

Request output for a)

Request output for b)

Proposed solution: Add necessary validation to all the fields and make the PR request field optional.

Apparently, creating too many of these requests on "/claims/add" can be DoS primitive.

Submit any issue/bug or suggest a new feature

Bug:Error while adding claims

Allow issues to be created only by logged In users

Claim Table gets deleted automatically

stats page

create a page called 'stats' that shows

total bounties claimed
total bounties accepted
total no of claims filed
total no of participants (anyone who has 1 claim, irrespective of accepted is participant)

total bounties means sum of bounty points

we are using semantic-ui so read up semantic docs, and make cards for each stat and make a nice UI for the page (not just a boring table 😆 )

Show Claims filtered By username
Filter Claims by status { Accepted, Rejected , Claimed }

[Enhancement] Add the gitter channel link to the homepage

Adding the link to join the gitter channel in the homepage (here: https://boss.codingblocks.com/) would be great helpful for those who directly visit the site homepage.

add a script to run migrations

migrations are in /db/migrations/<old-version>-to-<new-version>.sql
add a script called migratedb (use node itself, or shell - whatever you prefer, do not write in python/ruby or anything that is not required to run the rest of the project)
pickup db name user pass etc from secrets.json (example format is secrets-sample.json)
running migratedb --from 0.0.1 --to 0.0.3 should run all migrations like 001-to-002 and 002-to-003
just running migratedb should open interactive mode. chose which migration to run from a list of migrations.
if there are any DELETE/DROP commands in migrations, confirm with Y/N prompt in shell before executing that line

[Feature]Usernames should link to respective github profiles

Description

The usernames (highlighted by yellow colour) here should link to respective Github Profiles.

Mock

Filed a new feature (#49) .
@championswimmer Please approve this issue!