Skip to content

spagnoloG/lyricsProjection

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lyricsProjection

Modern WebApp for lyrics Projection in any place. Easily enter lyrics into the app, view, edit and project them on a remote screen.

homepage_image

Features

  • Inserting lyrics
  • Editing lyrics
  • Categorization of lyrics
  • Compiling Playlists
  • Projection of lyrics
  • Projection of playlists
  • Multiple projection displays supported
  • Active indicator
  • Active indicator of the current song in the web interface
  • Fully Mobile / Tablet supported

App gallery

Remote controller: app_gallery_1 Playlist controller: app_gallery_2 Inserting new lyrics: app_gallery_2

Project Structure

./client
    ./src
        ./store   <- app state (vuex)
        ./locales <- different translations location
        ./views   <- All routes and components that belong to them
./server
    ./api  <- REST API connected to local mongodb, runs in docker
    ./socket <- socket.io for fastest possible communication between server and projector

Installation

Firstly you must have docker and docker-compose installed. Then clone this app and run docker-compose up. First installation may take some time.

Management app will be available on your localhost at port 80. To preview what is on display you must go to /display route.

Fixes -> forks -> pull requests are welcome.