Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sbolel/express-pug-starter

Starter Node.js server with Express.js, Pug, scss, Mocha, Standard, eslint, and Contentful for CMS
https://github.com/sbolel/express-pug-starter

circleci cms contentful example express expressjs mocha nodejs pug sass scss starter-app starter-kit

Last synced: 14 days ago
JSON representation

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

Awesome Lists containing this project

README

        

# express-pug-starter

[![NPM version][npm-image]][npm-url]
[![License][license-image]][license-url]
[![NPM Dependency Status][daviddm-image]][daviddm-url]
[![NPM downloads][npm-downloads-image]][npm-url]


[![circle-ci][build-image]][build-url]
[![Test Coverage](https://codeclimate.com/github/sbolel/express-pug-starter/badges/coverage.svg)](https://codeclimate.com/github/sbolel/express-pug-starter/coverage)
[![Code Climate][codeclimate-image]][codeclimate-url]
[![js-standard][standard-image]][standard-url]

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

#### Getting Started

```sh
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](http://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 )
================================================================================
```

[npm-image]: https://img.shields.io/npm/v/express-pug-starter.svg
[npm-url]: https://npmjs.org/package/express-pug-starter
[npm-downloads-image]: https://img.shields.io/npm/dm/express-pug-starter.svg
[daviddm-image]: https://img.shields.io/david/sbolel/express-pug-starter.svg
[daviddm-url]: https://david-dm.org/sbolel/express-pug-starter
[license-image]: https://img.shields.io/npm/l/express-pug-starter.svg
[license-url]: https://github.com/sbolel/express-pug-starter/blob/master/LICENSE
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com/
[build-image]: https://circleci.com/gh/sbolel/express-pug-starter.svg?style=shield
[build-url]: https://circleci.com/gh/sbolel/express-pug-starter
[codeclimate-image]: https://codeclimate.com/github/sbolel/express-pug-starter/badges/gpa.svg
[codeclimate-url]: https://codeclimate.com/github/sbolel/express-pug-starter