Skip to content
This repository has been archived by the owner on Mar 30, 2023. It is now read-only.
/ express-pug-starter Public archive

Starter Node.js server with Express.js, Pug, scss, Mocha, Standard, eslint, and Contentful for CMS

License

Notifications You must be signed in to change notification settings

sbolel/express-pug-starter

Repository files navigation

express-pug-starter

NPM version License NPM Dependency Status NPM downloads
circle-ci Test Coverage Code Climate js-standard

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

Getting Started

git clone https://github.com/sbolel/express-pug-starter.git
cd express-pug-starter
cp .env_sample .env     # create dotenv file
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

Coverage

=============================== Coverage summary ===============================
Statements   : 78.18% ( 86/110 )
Branches     : 45.45% ( 10/22 )
Functions    : 40% ( 2/5 )
Lines        : 77.78% ( 84/108 )
================================================================================