davidosomething.com for 2016

Static generated site for davidosomething.com

Stack

Requires node >= 8.9.2 (I recommend using nvm, for which nvm use (or nvm install) will read .nvmrc and use the version of node specified there.

Install

Install dependencies:

npm install --global gulp jspm
npm install
jspm install

Note that gulp and jspm are only installed globally for local dev, whereas the CI-deployment uses npm run so the binaries in node_modules/.bin/ are in the path. You could technically use npm run ci-gulp-build if you don't want to install gulp globally.

Lint

• gulp lint will run all lint tasks
• gulp lint:js will run all lint tasks
• gulp lint:md:markdownlint will run markdownlint on the md/ directory. Markdown linting is not a build step and is done on demand only.
• gulp ci:lint will run all lint tasks (except markdown), this is for CI servers

Build

• Run gulp to build.
• Run gulp serve to start a local development server (via browser-sync)
• Run npm start to start an on-going browser-sync session

Deploy

There are npm scripts in package.json to build via CI.

Output is generated to public/ and, if running on master from Travis, the directory is deployed to surge.sh and the GitHub Pages repo.

Deployment from Travis CI is configured in bin/travis-deploy.sh.

TODO

• CSS
  • [ ] lint status to code climate
• JS
  • [ ] codecoverage to codecov.io
  • [ ] can further refactor share link popups
  • [ ] react view for each article and widget
  • [ ] hot module reload
  • [ ] current article should be highlighted if in a widget
• HTML
  • [ ] eventually remove hbs + metalsmith and use react + gatsby
• Content
  • [ ] add images
    • [ ] image hosting? e.g. cloudinary