https://github.com/dadi/boot
A module to help DADI apps boot uniformly.
https://github.com/dadi/boot
Last synced: 8 months ago
JSON representation
A module to help DADI apps boot uniformly.
- Host: GitHub
- URL: https://github.com/dadi/boot
- Owner: dadi
- Created: 2017-10-12T10:27:44.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-17T09:46:18.000Z (almost 2 years ago)
- Last Synced: 2025-08-23T13:44:28.066Z (10 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@dadi/boot
- Size: 55.7 KB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DADI Boot
> A module to help DADI apps boot uniformly.
## Usage
### Starting an app
In the file which is triggered by `npm start` e.g., `main.js`
```js
// Console start message
const dadiBoot = require('@dadi/boot')
dadiBoot.start(require('./package.json'))
```
`appName` looks at the `description` field in the `package.json` file, this should be the brand name for the app e.g., `DADI Web`
### Successfully started
Located where the app finishes its initialisation process.
```js
const dadiBoot = require('@dadi/boot')
dadiBoot.started({
server: `${config.get('server.protocol')}://${config.get('server.host')}:${config.get('server.port')}`,
header: {
app: config.get('app.name')
},
body: {
'Protocol': config.get('server.protocol'),
'Version': version,
'Node.js': nodeVersion,
'Engine': enginesInfo,
'Environment': config.get('env')
},
footer: {
'DADI API': config.get('api.enabled') ? `${config.get('api.host')}:${config.get('api.port')}` : '\u001b[31mNot enabled\u001b[39m'
}
})
```
> N.B. All fields are optional
#### `server`
The location where the app is launched or available for the user to be interacted with.
#### `header`
An object of strings to put in the header.
> N.B. The object keys are not currently used
#### `body`
An object of strings to output into a key|value table
#### `footer`
An object of supplementary information which the user might need to know, e.g., status of other connected microservices
### Errors
Accepts a string which is output as red in the terminal.
```js
dadiBoot.error(err)
```
### Stopped
To be triggered anytime the app is shutdown. Accepts a string which is output as red in the terminal.
```js
dadiBoot.stopped('Extra message')
```