innerdaze/universal-project-skeleton

Hej

How to Use

1. Decide what your project will be called. Ours will be called Jeff.

2. Clone this repo (replace "jeff" with your answer from Step 1)

-> git clone https://github.com/innerdaze/universal-project-skeleton.git jeff
-> cd jeff

3. Create another bare repo on Gitlab (we're going to continue the jeff theme here)

4. Setup your project to point at the new repo

-> git remote set-url origin http://git.orbistech.co.uk:1955/lee.driscoll/jeff.git

5. Install all the things

-> npm i

6. Rename the project

No one-liner for this yet (feel free to add). For now, edit the package.json using the world's greatest text editor and change the package name to whatever you want (guess what we called ours).

Bonus Points

6. Set the upstream to the original repo

-> git remote add upstream https://github.com/innerdaze/universal-project-skeleton.git

Applying changes to skeleton

Use git rebase to load in changes to the core skeleton, but review changes you want to pull because there's no guarantee nothing will break.

-> git pull --rebase upstream master

Tricks

Simplifying Output

Many of the provided npm scripts produce hierarchical output which can make tracking down the appropriate error difficult. In most cases where a step fails in the process the output will contain 2 error stacks: one you're interested in and the NPM error letting your know the parent script failed.

In order to simplify the output, use your bash skills to redirect the error output from NPM away from your precious field of view.

For example:

-> npm run start:dev 2>/dev/null

By Lee.