https://github.com/alphagov/gds-nodejs-boilerplate

A Node.js project boilerplate for production apps
https://github.com/alphagov/gds-nodejs-boilerplate

express govuk javascript mocha nodejs nunjucks xo

Last synced: about 2 months ago
JSON representation

A Node.js project boilerplate for production apps

• Host: GitHub
• URL: https://github.com/alphagov/gds-nodejs-boilerplate
• Owner: alphagov
• License: mit
• Archived: true
• Created: 2018-01-23T13:18:39.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-07T12:27:05.000Z (over 4 years ago)
• Last Synced: 2024-09-22T12:31:09.869Z (about 2 months ago)
• Topics: express, govuk, javascript, mocha, nodejs, nunjucks, xo
• Language: JavaScript
• Homepage:
• Size: 1.51 MB
• Stars: 19
• Watchers: 62
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GDS Node.js boilerplate

This is a skeleton Node.js app running on [Express] with [Nunjucks] as a template engine.

It includes:

- Grunt for compliation of sass/js

- [GOV.UK Frontend]

- [Browserify] with babelify and Nunjucksify

- Mocha for testing

- Middleware to set correlation headers

- i18n language support

- [Snyk]

- [StandardJS] for linting

- [nvm] (optional) for nodejs version

To get started clone the repo and run

``` bash

$ npm install

$ npm start

```

(`npm install` might error about Snyk if it’s not set up but ignore for now)

Then go to [http://localhost:3000/](http://localhost:3000/) to see it in action.

### Using nvm (optional)

If you work across multiple Node.js projects there's a good chance they require different Node.js and npm versions.

To enable this we use [nvm (Node Version Manager)](https://github.com/creationix/nvm) to switch between versions easily.

1. [install nvm](https://github.com/creationix/nvm#installation)

2. Run `nvm install` in the project directory (this will use [.nvmrc](/../../.nvmrc))

3. Follow the steps above to install and start

[Express]: https://expressjs.com/

[Nunjucks]: https://mozilla.github.io/nunjucks/

[Snyk]: https://snyk.io/

[GOV.UK Frontend]: https://design-system.service.gov.uk/

[Browserify]: http://browserify.org/

[StandardJS]: https://standardjs.com/

[nvm]: https://github.com/creationix/nvm