Skip to content

Latest commit

 

History

History
86 lines (46 loc) · 3.15 KB

README.md

File metadata and controls

86 lines (46 loc) · 3.15 KB
Raw

Requeue

requeue logo

Receive and queue song requests in a closed network with an intuitive platform that provides you with control on what song plays next.

Requeue screenshots

Getting Started

Getting started with Requeue requires a couple of steps involving the following:

  1. Clone the repository:

    $ git clone https://github.com/gaber85/docco-frontend.git $ cd docco-frontend

  2. Install global and local dependencies:

    Node: Navigate to page and download

    Npm: Package manager for JavaScript

    MongoDB: macOS, Windows, Linux

    Installing dev dependencies for client and server:

    $ cd client $ npm i

    &

    $ cd server $ npm i

  3. Start MongoDB using terminal: $ mongod

  4. Update the .env file with the required Spotify api secret and database url

  5. Start the back-end development server:

    $ node index.js

  6. Run the front-end development server:

    $ npm start

FAQ

How do I get started?

From the landing page, click sign in with Spotify and accept the permissions.

How do I host a new session?

Once you are logged in and in the wecome page, click on the 'Host' button. This will automatically generate a code word that can be shared with users to join the playlist. In order to use the host feature, the user needs to hold a Spotify Premium account.

Can I add any song to the list?

Any song found in the Spotify database can be added, so long as the song is available in your region. Navigate to the search area by clicking on the search button at the bottom of the dashboard page.

How do I play music on the browser?

After choosing to host a session, the user will be taken to the host dashboard where a play button will appear at the top of the page. Press play and a web player will load with the basic music controls. Pressing the arrow down on the right hand side of the screen will start playing songs from the created playlist.

Tech Stack

React - A declarative, efficient, and flexible JavaScript library for building user interfaces.

Redux - Predictable state container for JavaScript apps.

Spotify API - A Node.js wrapper for Spotify's Web API.

Koa - Expressive middleware for node.js using ES2017 async functions

MongoDB - A NoSQL document database

Contributing

Requeue is an open source project and contributions are welcome. Please fork the repo and submit a pull request for review.

Authors

Gabriel Riera: Github & LinkedIn