README.md

musicem-app(v1.0.0-alpha)

Music Curating App Built Using MEAN Stack. Firebase auth for facebook login. Deployed to google cloud server: http://musicemapp.com

INSTALL

Install all node package dependencies

npm install

Install nodemon globally to continuously monitor the server

npm install -g nodemon

Install mocha globally to test the app

npm install -g mocha

Install gulp globally to run app tasks

npm install --global gulp-cli

BOWER

Install bower globally

npm install -g bower

Install bower components for client side

bower install

BROWSER SYNC

Install browser sync globally

npm install -g browser-sync

GULP TASKS

Default gulp task to start server, watch sass, and run browsersync

gulp

run server using nodemon

gulp nodemon

compile sass files once

gulp sass

watch sass files

gulp watch

run browser-sync

gulp browser-sync

UNIT TEST

Run mocha test for app.

npm test

CONFIGURE

Configure .env file for database. Here are some acceptable sample environment variables one will receive from firebase.google.com to initialize a firebase app.

NODE_ENV=development
PORT=3000
FIREBASE_API_KEY="<api_key>"
AUTH_DOMAIN="<project_id>.firebaseapp.com"
DATABASE_URL="https://<database_name>.firebaseio.com"
STORAGE_BUCKET="<bucket>.appspot.com"
M_S_ID=1234567891234

AUTHENTICATION

FirebaseUI is built on top of firebase for easy user login/register.

RUN

After running app. visit it from the default port at: http://localhost:3000

npm start

or

npm monitor