startled v0.0.0

startled

Startled is a starting point for creating projects using modern tools and best practices. It makes heavy use of npm as a script runner and package.json for storing project data. The project's capabilities can be extended by running scripts (see below).

pre-requesties

• npm & node
• git

installation

new project

• clone this repository

git clone git@github.com:johnhenry/startled.git

• reinitialize

git init

• install

npm install

• initialize locally

npm run local-init

• start coding

existing project

• If you have an existing project with a package.json, copy "scripts" and "devDependencies" from this repository's package.json into it.

• continue coding

internals

included files

.npmrc

set up with 'save=true' to save installed dependencies automatically

.gitignore

set up to ignore 'node_modules/' folder

included npm scripts

yarn: package manager

get: read a key from package.json

set: add a key to package.json

delete: remove a key from package.json

local-init: initialize project

This is a special script that should be run once after a project is cloned from a git repository or after 'git init' is run. It does a few things...

• creates git script to add tag after running npm version <'patch'|'minor'|'major'>

##using npm

• update project version with "npm version <'patch'|'minor'|'major'>"
• install package with "npm run yarn add "

##adding capabilities Update capabilities by running scripts in the project directory.

• Compile latest version of css into a self-contained slug

sh -c "$(curl -fsSL https://raw.githubusercontent.com/johnhenry/startled/master/scripts/css-next-slug.sh)"

• Compile latest version of javascript into a self-contained slug

sh -c "$(curl -fsSL https://raw.githubusercontent.com/johnhenry/startled/master/scripts/js-next-slug.sh)"

• Compile latest version of javascript into a self-contained slug for use in the browser

sh -c "$(curl -fsSL https://raw.githubusercontent.com/johnhenry/startled/master/scripts/js-next-browser-slug.sh)"