@dotcom-tool-kit/node 2.2.3 → 2.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +3 -3
- package/readme.md +34 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dotcom-tool-kit/node",
|
|
3
|
-
"version": "2.2.
|
|
3
|
+
"version": "2.2.5",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "lib",
|
|
6
6
|
"scripts": {
|
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
"dependencies": {
|
|
13
13
|
"@dotcom-tool-kit/error": "^2.0.1",
|
|
14
14
|
"@dotcom-tool-kit/state": "^2.0.1",
|
|
15
|
-
"@dotcom-tool-kit/types": "^2.
|
|
16
|
-
"@dotcom-tool-kit/vault": "^2.0.
|
|
15
|
+
"@dotcom-tool-kit/types": "^2.8.0",
|
|
16
|
+
"@dotcom-tool-kit/vault": "^2.0.12",
|
|
17
17
|
"get-port": "^5.1.1",
|
|
18
18
|
"tslib": "^2.3.1",
|
|
19
19
|
"wait-port": "^0.2.9"
|
package/readme.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# @dotcom-tool-kit/node
|
|
2
|
+
|
|
3
|
+
Run your Node application.
|
|
4
|
+
|
|
5
|
+
This plugin will be installed as a dependency of the [frontend-app](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/frontend-app), [backend-app](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/backend-app) plugins so you do not need to install it separately if you are using either of those plugins.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
Install `@dotcom-tool-kit/node` as a `devDependency` in your app:
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npm install --save-dev @dotcom-tool-kit/node
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Add the plugin to your [Tool Kit configuration](https://github.com/financial-times/dotcom-tool-kit/blob/main/readme.md#configuration):
|
|
16
|
+
|
|
17
|
+
```yaml
|
|
18
|
+
plugins:
|
|
19
|
+
- '@dotcom-tool-kit/node'
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Options
|
|
23
|
+
|
|
24
|
+
| Key | Description | Default value |
|
|
25
|
+
|-|-|-|
|
|
26
|
+
| `entry` | path to the node application | `'./server/app.js'` |
|
|
27
|
+
| `useVault` | option to run the application with environment variables from Vault | `true` |
|
|
28
|
+
| `ports` | ports to try to bind to for this application | `[3001, 3002, 3003]` |
|
|
29
|
+
|
|
30
|
+
## Tasks
|
|
31
|
+
|
|
32
|
+
| Task | Description | Default hooks |
|
|
33
|
+
|-|-|-|
|
|
34
|
+
| `Node` | Run node application | `run:local` |
|