GithubHelp home page GithubHelp logo

austinlyon / slick Goto Github PK

View Code? Open in Web Editor NEW

This project forked from chattree/slick

2.0 2.0 0.0 86 KB

Slack for Music: provide real time event driven collaboration between users for synchronized music playback and DJ delegation

License: MIT License

JavaScript 91.13% HTML 1.56% CSS 7.31%

slick's Introduction

slick Build Status Coverage Status

Slack for Music: provide real time event driven collaboration between users for synchronized music playback and DJ delegation

##Overview ###Tech Stack

  • React
  • rollup (bundling)
  • Socket.io
  • Mocha
  • Chai
  • Supertest
  • socket.io-client
  • Node + Express

###Front-end

  • built in React
  • 4 different components <Main> <SongPlayer> <SongQueue> <Songs>
  • <Main> is component where DOM event and socket event handling happens (ex: play, pause, onPlay socket emit events, etc..)
  • <SongPlayer> is component where <audio> element is mounted and where audio playback events are listened to and events passed back up to <Main>
  • <SongQueue> is container component to hold <Songs> components
  • <Songs> is view component which displays song information in queue

###Back-end

  • See simple chat application using Socket.io here http://socket.io/get-started/chat/ to get up to speed with how to use sockets
  • There are 3 socket events
    • playCurrent: all client sockets emit this event when user triggers play on song player; all client sockets listen for this event to play current song
    • pauseCurrent: same as the playCurrent event except pauses the current song
    • songEnded: socket event dispatched when current song is done playing

##Getting Started

  1. Get your own Soundcloud client id at http://soundcloud.com/you/apps/new and use in client-id.js file

  2. Configure and define IP address of person hosting DJ room in main.js when instantiating <Slick> component

  3. npm install

  4. rollup -c to bundle up React source files

  5. npm start to start server

rollup -c each time you make changes to client side react .js files to bundle files

##Features to Implement

  • Chatroom UI
  • Friends List UI
  • User login with DB: persist user information for friends list / chat
  • DJ power: only 1 person can change songs currently playing in chat room
  • Data Persistence on server: save song list queue on server side to synchronize current playing song across users in chat room

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.