Code Monkey home page Code Monkey logo

cgn's Introduction

Build Status

Crunchy Gaming Network

Discover and connect with your Facebook friends across multiple gaming platforms. Read the full synopsis in our press release

##Usage TBD

Getting Started (Developer)

Prerequisites

  • Node 5.8
  • Git

Fork & Clone Repo

  1. Fork the repo through Github
  2. git clone https://github.com/YOUR_USER_NAME/CGN.git

Install Dependencies

From the root directory of the cloned repo in your terminal:

npm install -g webpack // sudo may be required for global installs
npm install -g webpack-dev-server
npm install -g json-server
npm install
npm install --only=dev

Start Development Server

Run npm build to do an initial compilation and bundling of static assets.

Run npm start.

This will start the webpack-dev-server which will serve the bundled angular app as well as static assets. The webpack-dev-server will watch the client side javascript files for changes and hot load them into the page when a change occurs. Any requests to the CGN API will be proxied to a json-server running on a separate port, which will respond with mock data.

To test against live data in the staging or production environment, you can edit the proxy location in webpack.dev.js to point to a different endpoint, such as the production or staging URL.

STACK

  • Front-end
    • Angular 1.5x
    • Webpack + Babel
  • Web tier
    • Heroku
    • Node 5.x
    • express
    • passport
    • oauth.io
    • sequelize ORM
  • Data tier
    • MySQL
      • ClearDB (Heroku addon)

3rd Party APIs

API

(Final API TBD)

Profiles

GET: '/users/friends/' --- getFriends POST: '/users/friends/' --- addFriends PUT: '/users/friends/' ---- updateProfile

Steam related

POST: '/steam/games' --- saves the list of games the user has into db GET: '/users/steam' --- gets steam information saved from db POST: '/users/streams' --- saves the account information into db

STEAM API CALLS:

note: all steam API calls require a query ('?steamID=') or gameID GET: '/updateSteam' --- getSteamProfile, retrieves gamer tag/profile picture GET: '/updateSteamFriends' --- getSteamFriends, retrives full list of steam friends GET: '/getSteamGames' --- getSteamGames, get a list of all steam games a particular steam ID owns GET: '/getGameInfo' --- getGameInfo, retrieves information on a particular game using gameID as it's parameter/query

OAUTH

GET: ‘/auth/FB’ GET: ‘/auth/FB/confirm’ GET: ‘/success’ -> Home GET: ‘/fail’ -> Sign In

Project Structure:

TBD

Feature Roadmap

Progress

Throughput Graph

Build History

Build Status

See past builds here.

Contributing

  1. Make sure you have eslint setup in your editor of choice.
  2. Follow the Angular Style Guide.
  3. All new contributions should be written in ES6 and follow the AirBnB Javascript Style Guide. (Following the first step will help you with this).
  4. Follow the instructions in our Contribution Guidelines.

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.