Skip to content

Athear/kARaoke

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

294 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

License: MIT

k{AR}aoke


partyslice

Table Of Contents


  1. Description
  2. Installation
  3. Usage
  4. Contributing
  5. Review and Contribute

Description


k{AR}aoke features song and lyric videos with an Augmented Reality twist. Each song has a unique effect that makes you the star of a real-time music video! Be sure to refresh time after time so you can perform all four songs. Dont want the fun to end? Take a screenshot during your performance so you can relive that aha! moment!


Installation


The app is deployed at the Heroku link listed below but if you wish to install it locally and contribute simply,

  1. Clone the repo and fire npm i in the command line.
  2. Next, input npm run seed in order to seed the database with the costumes and filters and songs
  3. Finally, npm start will run the application and bring up the local host in the browser.

Usage


  1. First you will need to create a user name and password.
  2. Then, login will take you to the stage page. Here the canvas will be displayed along with a carousel of all of your song selections.
  3. To get started pick a song! This will automatically set the stage with either the props used in that scene, or a specific filter with which to perform in.
  4. If you would like to start over, the refresh button brings back the song selection wheel component.
  5. If you would like to take a screen shot the button to the left will take a snapshot and save it to your local machine.
  6. If you would like to logout hit the next button to be taken back to the login page.

screenshot


Contributing


Pull requests are always welcome. When contributing to this repository, please first discuss the change you wish to make via email or issue. After approval, please follow the "fork-and-pull" Git workflow.

  • Fork the repo on GitHub
  • Clone the project to your own machine
  • Commit changes to your own branch
  • Push your work back up to your fork
  • Submit a Pull request so that we can review your changes

Review and Contact Developers Here


Github: k{AR}oke

Heroku Deployment:k{AR}oke LIVE

Contributors:

Chris Gutierrez - cmgson1@gmail.com
Carolyn Hilpisch - ckhilpisch@gmail.com
Jennifer Nelson - jennifer.nelson242@gmail.com
Markki Meyer - markkimeyer@gmail.com
Todd Malone - toddomalone@gmail.com


About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors