karatube? youaoke? karayouoketube?? dunno. create a queue of youtube videos, maybe they're karaoke videoz. maybe you got a mic. ...maybe
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_layouts
e2e
projects
server
src
.editorconfig
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
README.md
_config.yml
angular.json
googleauth.js
gtest.js
icon.icns
index.md
main.js
package-lock.json
package.json
tsconfig.json
tslint.json
youoke.png

README.md

YOUOKE {README} 🎤

karatube? youaoke? karayouoketube?? dunno. create a queue of youtube videos, maybe they're karaoke videoz. maybe you got a mic. ...maybe

edwardsharp.github.io/youoke

Getting started with development

Interested in contributing to YOUOKE? Have a look at the Contributing Guidelines and the current issues

Google API

Turn on the YouTube Data API. Generate a YouTube API Key-- you will need to enter this into the settings of the YOUOKE app.

In the future, hopefully, there will be more integration with the YouTube API, so an oAuth client secret will need to be setup, like so:

  1. Use this wizard to create or select a project in the Google Developers Console and automatically turn on the API. Click Continue, then Go to credentials.
  2. On the Add credentials to your project page, click the Cancel button.
  3. At the top of the page, select the OAuth consent screen tab. Select an Email address, enter a Product name if not already set, and click the Save button.
  4. Select the Credentials tab, click the Create credentials button and select OAuth client ID.
  5. Select the application type Other, enter the name "YOUOKE" (or whatever), and click the Create button.
  6. Click OK to dismiss the resulting dialog.
  7. Click the ⬇️ (Download JSON) button to the right of the client ID.
  8. Move the downloaded file client_secret_3255645blahblahblah.json to your working directory and rename it client_secret.json.

Development environment

Run ng serve for the main YOUOKE project. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Run ng serve partyline --port 4201 to start the partyline project that allows people to search & queue song requests.

Run npm start to start the ElectronJS & Angular dev env.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

note: use --module=app e.g. ng generate @angular/material:material-nav --name=sidenav --module=app

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

ng build -aot --prod

for electronjs:
ng build --base-href=""
ng build --aot --prod --base-href=""

-or-
npm run webbuild which is: ng build --aot --prod --base-href=''
npm run partylinebuild which is: ng build --aot --prod partyline
npm run partylinedev which is: ng serve partyline --port 4201 npm run electronbuild which is: electron-builder . -m (build mac osx package)

electronjs

electronjs release OSX build:
./node_modules/.bin/electron-builder . -m
-or-
./node_modules/.bin/electron .

⚡️

socket server

cd server/ npm start

socket server will be available, by default, on port 8091

see: server/README.md

Running unit tests

Run ng test to execute the unit tests via Karma.

end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

MISC

This project is built with: