Tenet Partners Holiday Card 2015

A short, fun questionnaire that stores and displays anonymous responses.

Setup

Requires node and npm. brew install node gets you both.

1. npm install
2. gulp

Build environment

Running gulp starts the development environment. All CSS and JS files are monitored and changes will automatically reload the browser via browser-sync.

CSS

Place Sass files in ./styles. Write valid CSS and autoprefixer will take care of any vendor prefixes.

JavaScript

Place your scripts in ./scripts. Uses browserify to bundle all client files together.

Images or other assets

Create a ./assets folder to place images, downloads, or other miscellaneous files. These will be automatically copied to the ./build folder.

Testing

Create a __tests__ folder next to the scripts that you would like to run tests for. To enter test driven development mode, run gulp tdd. This will watch your test files and source files for changes and run tests automatically as a result. Run gulp test to run all tests once, or run gulp test:coverage for a complete code coverage report.

Deploying

1. Create an AWS S3 bucket and get your credentials
2. AWS credentials are read from a file located according to the AWS API guidelines. (file located at ~/.aws/credentials)
3. Add your AWS S3 bucket name to the object in ./gulp-utilities.js. You can add any key name you want i.e

deploySettings:{
    deployTarget: { // these should be aws s3 bucket names, called via gulp deploy --target={key}
        dev: "yourdevs3bucketname",
        prod: "yourprod3bucketname",
        another: "other"...
    },
    ...
}

4. Now you can run gulp deploy --target=dev (or any other target name) and your project will be cleaned, built and deployed.

---

Heavily inspired from React for Beginners and Testing ES6 React components with Gulp + Mocha + Istanbul.