Git Product home page Git Product logo

battle-code's Introduction

Battle-Code

Battle your peers head-to-head with intense coding challenges.


Team


## Table of Contents
  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Roadmap
  4. Contributing
  5. Architecture
  6. API
  7. Deployment

## Usage

Load up the arena and try to complete as many of the test cases for the coding challenge as possible before your opponent.


## Requirements
  • Node 0.10.x
  • Express -
  • Postgresql 9.1.x
    • ORM
  • React -
  • Redux -

## Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Roadmap

View the project roadmap here


## Contributing + Github Workflow

See github.md for contribution and github workflow guidelines.


## Architecture ### High Level Architecture ![](http://i.imgur.com/mqdnWVh.png)

Database Schema

Database in Postgres, using Bookshelf and Knex

Socket Interactions

API

Public End Points
Request URL Response
Log-in /auth/github
Log-out /logout
Verify User /auth-verify userObj
Get User /api/users/:githubHandle userObj
Get Match History /api/users/:githubHandle/matches/ [matchObj...]
Get User's Solutions /api/solutions/user/:gitubHandle [solutionObj...]
Get Solution /api/solutions/:solutionId solutionObj
Get Leaderboard /api/solutions/:challenge_id/top [solutionObj...]
Get Challenge /api/challenges/:challengeId [challengeObj...]
Admin Only
Request URL Response
GUI Access to Database /addProblemsSolutions.html
Add Challenge /api/challenges challengeObj
Get Random Challenge /api/challenges challengeObj
Add User /api/users userObj
Empty Database /api/resetDB
Reseed Database /api/resetDBWithData
Reseed Challenges Table /api/resetChallenges

Deployment

This has been deployed onto Digital Ocean using Docker containers. The backend architecture allows horizontal scaling of the solution worker to handle higher loads

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.