Skip to content

Latest commit

 

History

History
82 lines (66 loc) · 3.41 KB

README.md

File metadata and controls

82 lines (66 loc) · 3.41 KB

Application Components

  • Node >= 8.5
  • npm >= 5.3
  • Webpack 3.6.0
  • Webpack Dev Server 2.9.1
  • React 16.0.0
  • ReactDOM 16.0.0
  • Node Sass 4.5.3
  • ESLint 4.6.1
  • Babel 6.26.0
  • View Templating with Pug 2.0.0-rc.4
  • Style Library Font Awesome 4.7.0 (via Node Sass Imports)
  • A Server
  • A Client
  • Some Hot Drama, Perhaps.
  • Cow Houses!!!

Instructions

  1. clone, or whatever

  2. cd into directory

  3. npm install

    npm install -g eslint
    • Also, you might need to install some globals like this
      npm i -g "gulpjs/gulp#4.0" eslint
    • If you already have gulp installed globally then;
      npm uninstall -g gulp && npm i -g "gulpjs/gulp#4.0"
  4. set node env for Prod build (set on windows, export on LINUX/UNIX)

    export NODE_ENV=production
  5. Make views in ~/views

  6. Develop in ~/src

  7. run the dev boxes

    gulp dev

Gulp Tasks Aplenty

Server

KNOW the effect you intend to create

Patterns Effects
gulp server:cleaning Removes the ./build directory
gulp server:building Removes the ./build directory,
Compiles a new one
gulp server:watching Removes the ./build directory,
Compiles a new one,
Watches ./src/server for, and repeats on Changes
gulp server:dev Removes the ./build directory,
Compiles a new one and runs tests,
Watches for & repeats on Changes With Nodemon
gulp server:test Removes the ./build directory,
Compiles a new one and runs tests
gulp server:test:dev Removes the ./build directory,
Compiles a new one and runs tests,
Watches ./src/server for, and repeats on Changes With Nodemon

NOTE: Should not crash on ERROR, should log errors to Console

Client

Patterns Effects
gulp client:clean Removes the ./public/build directory
gulp client:build Removes the ./public/build directory,
Compiles a new one
gulp client:dev Removes the ./public/build directory,
Compiles a new one,
Watches /build/ for, and repeats on Changes

Dev

Patterns Effects
gulp dev Runs server:dev and client:dev in parallel

Issue Reporting

Rules

  1. Be kind, and concise.
  2. If you don't like Cow Houses, Look for another package.

Template

  1. Include steps to reproduce

  2. A Debug or stacktrace pasted in 'should' contain the first line or so which should relate to the item in question. (please don't paste spaghetti)