Developing.md

Requirements

• npm https://www.npmjs.com/
• nodejs https://nodejs.org/en/

Installation/Setup

git clone https://github.com/hueyjj/skadoosh
cd skadoosh
npm install

Then

npm run dev

or

npm run serve

And that's it!

The rest of this guide is for developers or those that want to do more.

Building

Compiles the source into a static bundle to be served.

npm run build

Serving

Serves a static bundle of js, html, css, asset files etc on a port.

npm run serve

Testing locally (unoptimized build)

Starts the web app directly.

npm run dev

Testing locally (optimized build)

This script combines npm run build and npm run serve. This is also the starting script on Heroku.

npm run prod

Heroku

Enter username and password provided by the author.

heroku login

Simulate the web app locally.

heroku local web

Check the build log on Heroku's server.

heroku logs
herou logs --tail # Get real-time update of logs

Git

Github remote

origin [email protected]:hueyjj/Skadoosh.git

Heroku remote

heroku https://git.heroku.com/skadoosh-115.git

Running git remote -v should yield an output like below

$ git remote -v
heroku https://git.heroku.com/skadoosh-115.git (fetch)
heroku https://git.heroku.com/skadoosh-115.git (push)
origin [email protected]:hueyjj/Skadoosh.git (fetch)
origin [email protected]:hueyjj/Skadoosh.git (push)

Branching

Update remote branches to local branches

git fetch -v

Branch off of master always and do your work in your own branch

git checkout master
git branch YOUR_NAME/YOUR_FEATURE_OR_OBJECTIVE
git checkout YOUR_NAME/YOUR_FEATURE_OR_OBJECTIVE

Push to your branch only

git push origin YOUR_NAME/YOUR_FEATURE_OR_OBJECTIVE