A letter-writing project celebrating women in public life and struggles for liberation.
HTML CSS JavaScript Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
tasks
.editorconfig
.gitignore
.stylelintrc
.travis.yml
LICENSE
README.md
deploy-gh-pages.sh
foley.json
gulpfile.babel.js
package.json
webpack.config.js

README.md

Dear Friend

Code base for Dear Friend using Phil Lennon's fantastic Foley

Build Status

Install

  • Install Node 4 LTS or 5 stable (preferred),
  • Run in Terminal: npm i gulp-cli -g (Gulp does not need to be installed globally),
  • Navigate to the workflow folder in command line Terminal,
  • Run: npm i.

Please note, there are a large amount of development dependencies to install due to the 'all in one' nature of this workflow. It could possibly take several minutes to install the modules.

Optional Installs

The following plugins for Atom are recommended but not required:

  • editorconfig,
  • linter,
  • linter-handlebars,
  • linter-js-standard,
  • linter-stylelint,
  • tabs-to-spaces.

Usage

Run these tasks in your command line Terminal:

gulp [--production] [--debug]

gulp deploy [--production] [--debug]

gulp auditcode

  • The gulp task builds the website, watches for changes and starts up a sever,
  • The gulp deploy task builds the website without watching for changes or running the server,
  • The gulp auditcode task runs various linting on the project source files.
  • The --production flag builds minified assets with no sourcemaps,
  • The --debug flag shows the files being created in each task (if the task has a pipe).