Overview

• Server
  • Express.js
  • Contentful (optional)
  • Firebase (optional)
• Testing
  • Mocha, Chai for unit testing
  • Supertest for testing routes
  • Istanbul coverage reports
  • linters
    • standard style
    • eslint
    • scss-lint
• Integrations
  • CircleCI continuous integration
  • CodeClimate code analysis

Requires Node.js and npm, which can both be installed by following the instructions on https://nodejs.org/. Installing Node.js also installs npm.

Requires Ruby & Compass for building styles.

Getting Started

git clone https://github.com/sbolel/express-pug-starter.git
cd express-pug-starter
cp .env_sample .env     # create dotenv file and add missing vars
npm install             # install dependencies

Server

npm start - start application on localhost:4000

npm run debug - for debugging, start the app using [nodemon][nodemon]

Tests

npm test – run tests with [Mocha][mocha], validate standard style, generate coverage report (.coverage/)

Styles

npm run sass - compile scss

npm run sass:watch - compile scss, watch for changes