Giter Club home page Giter Club logo

boss's Introduction

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

boss's People

Contributors

aannaassalam avatar abhishek97 avatar ananay avatar ankiiitraj avatar architkshk avatar arushisinghal avatar bhavyaagg avatar championswimmer avatar codingblocks-bot avatar dhroov7 avatar firefinchdev avatar hashtalmiz avatar iamravitejag avatar imdhruvgupta avatar jatinkatyal13 avatar jeetintyagi avatar mansiagarwal451 avatar mukulsaini avatar nikhilhassija avatar nshul avatar paras151 avatar prabalsingh24 avatar prateekiiest avatar prathambatra avatar shakeabi avatar shivam7374 avatar thenamankumar avatar v27u27 avatar witty123 avatar yashkumarverma 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.