Skip to content

Scheming-Lion/jetgrizzly

 
 

Repository files navigation

Stories in ReadyBuild Status

jetgrizzly

Providing an open, accessible forum for exchanging videos and interacting online.

Team 1

  • Product Owner: Alex Jeng
  • Scrum Master: Jose Merino
  • Development Team Members: Moxi Zhou, Jeff Gladchun

Team 2

  • Product Owner: Justin Pinili
  • Scrum Master: Will Burgo
  • Development Team Members: Oleg Yanchinskiy, Adam Back

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Architecture
    2. Installing Dependencies
    3. Tasks
  4. Team
  5. Contributing

Requirements

  • Node 0.10.x
  • Redis 2.6.x
  • Postgresql 9.1.x
  • etc
  • etc

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Architecture

  1. Heroku + Build Control
    1. Easy Build and deployment process
  2. Travis CI
    1. Automated CI Testing
    2. Continuous Deployment
  3. Firebase
    1. The only backend structure for the app
    2. Simple Login / Auth
    3. Real-time 3-way Data-binding
  4. Express Master Client
    1. Serves static assets
    2. Manages video queue
  5. Grunt
    1. Testing
    2. Build
    3. Tasks
  6. Karma
    1. Unit tests
  7. Angular
  8. Youtube API
  9. Bootstrap

More info: Architecture

Getting Started

  • All of the server information can be found in doc/architecture.md
  • All of our database information is stored on Firebase. The YouTube player listens for changes in firebase and then it will load the next video in the queue.
  • The server listens to changes on the YouTube player state. When a video ends, it will tell the server to load up the next video.
  • The express server acts as the 'master user', and manages all of the Firebase changes.
  • Currently the app requires that you register and login before you can submit a chat message.
  • The automatic deployment works off of the develop branch, not the master branch

Known Bugs

  • If you insert an invalid link, the server will crash and you will have to restart it. Our current regex filter checks to see if a link is a youtube url, but not if it's a valid one.
  • If the next video in queue is the same as the current video, it will not update
  • Chatroom doesn't scroll to bottom as a default

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 77.1%
  • JavaScript 22.6%
  • Shell 0.3%