Git Product home page Git Product logo

yail's Introduction

Yail

A real-time collaborative song-request queue for Spotify.

๐ŸŽง Demo

You can access the live demo at: https://yail.herokuapp.com/

preview

โš™๏ธ Environment variables

You have to create a Spotify app. You can refer to the official documentation to create in a minute.

After created your app, you must first define the following environment variables:

  • SPOTIFY_CLIENT_ID
  • SPOTIFY_CLIENT_SECRET

You can put them inside a .env file at the root of the project or by manually exporting them.

๐Ÿณ Using Docker

docker build yail:latest .
docker run yail

๐Ÿš€ Self-hosting

You can easily self-host this app. The easiest version is to run the app with Docker.

You have to define the following mandatory environment variables.

  • SECRET_KEY_BASE (64 bytes)

A secret used to encode session and other sensitive data. For security reasons it must be composed of at least 64 characters.

You can easily generate it inside the root of this repo using the mix phx.gen.secret command:

mix phx.gen.secret 64
  • BASE_URL

The base URL of the web application. This is for example the URL of a custom domain: https://example.com or an ip address.

๐Ÿง‘โ€๐Ÿ’ป Get started

To start your Phoenix server:

  • Install dependencies with mix deps.get
  • Install Node.js dependencies with npm install inside the assets directory
  • Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

๐Ÿ— Built with

๐Ÿ“ง Contributing

All contributions are welcome. Code must be formatted with hex format.

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.