Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daniel-ac-martin/foundation
A Node.js/Express-based framework for building .gov.uk forms.
https://github.com/daniel-ac-martin/foundation
Last synced: 24 days ago
JSON representation
A Node.js/Express-based framework for building .gov.uk forms.
- Host: GitHub
- URL: https://github.com/daniel-ac-martin/foundation
- Owner: daniel-ac-martin
- License: gpl-2.0
- Created: 2015-11-01T17:36:59.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-11-02T00:41:32.000Z (about 9 years ago)
- Last Synced: 2024-12-06T13:50:48.820Z (about 1 month ago)
- Language: JavaScript
- Size: 1.15 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# BRP Application project for nodejs
[](https://quay.io/repository/ukhomeofficedigital/brpapp)
## Quick start
Install the dependencies and build the project resources
```bash
$ npm install
```
Initiate the server in development mode (Express is used to serve the static resources in development).
```bash
$ npm run dev
```
Then select one of the following journeys to see the applcation in action
- [Collection](http://localhost:8080/collection)
- [Someone else](http://localhost:8080/someone-else)
- [Not arrived](http://localhost:8080/not-arrived)
- [Correct mistakes](http://localhost:8080/correct-mistakes)
- [Lost, damaged or stolen](http://localhost:8080/lost-damaged-stolen)
See the [development documentation](./documentation/DEVELOPMENT.MD) for a complete description of the application and how to maintain and support BRP.
## NPM scripts
Start the application in default mode (production).
We use Nginx to serve our static resources in production and ci.
```bash
$ npm start
```
Start the application with [Nodemon](https://www.npmjs.com/package/nodemon) in development mode.
Debug is switched on and the server restarts when the JS or Sass are recompiled.
```bash
$ npm run dev
```
Run the unit tests
```bash
$ npm run test
```
Run the EcmaScript (ES) linter. Rules are defined in [.eslintrc](./.eslintrc)
```bash
$ npm run lint
```
Run the jscs style checker. Rules are defined in [.jscsrc.json](./.jscsrc.json)
```bash
$ npm run style
```
Analyse the quality of the codebase (for results - open [./reports/plato/index.html](./reports/plato/index.html))
```bash
$ npm run quality
```
Compile the Sass to CSS
```bash
$ npm run sass
```
_____________________________________________________________
- For details on [Acceptance tests](https://github.com/UKHomeOffice/brp_app/tree/master/acceptance_tests)
- See the [package.json](./package.json) for a full list of scripts.
- Full list of [environment variables](./documentation/ENVIRONMENT_VARIABLES.md)