Like WhenIsGood, but gucci.
For CS3141 (Team Software Project) Spring 2018.
Setup
Local Development
Install:
- Node.js 8.x (check version with
node -v
) - Yarn
- Gulp (install with
yarn global add gulp-cli
) - EditorConfig plugin for your editor/IDE
git clone
the repocd
to the root of the repo- Run
yarn
to grab dependencies - Create the
.env
file in the repo root - Run
gulp
to start the Express server and Gulp watch tasks - Code away, commit changes, and profit!
Deploying/Production
Install:
- PM2 (install with
yarn global add pm2
)
git clone
the repocd
to the root of the repo- Run
yarn
to grab dependencies - Run
gulp build --production
to build production-ready assets - Run
NODE_ENV=production pm2 start app.js
to start the server with PM2
NOTE: Assets need to be re-built manually after pulling down changes.
Gulp Tasks
There are several gulp
tasks that can be useful when developing:
serve
spins up a local server (is thedefault
task)--prod/--production
to serve the production assets (mimics production site)--tunnel
to create a temporary URL via localtunnel.me (to share with someone)
build
builds the assets--prod/--production
builds for production (minify, optimize, etc.)
clean
wipes the build directory