@dotcom-tool-kit/next-router v3.4.1
@dotcom-tool-kit/next-router
Tool Kit plugin to run an application via the next-router
in a local environment (on the run:local
hook).
Installation & usage
With Tool Kit already set up, install this plugin as a dev dependency:
npm install --save-dev @dotcom-tool-kit/next-router
And add it to your repo's .toolkitrc.yml
:
plugins:
- '@dotcom-tool-kit/next-router'
Running an app via next-router
For an app to be loaded via the next-router
(https://local.ft.com:5050), the app will need to be loaded before the next-router
plugin. This is done by defining the run:local
hook to run the application before NextRouter
task. Here is an example full config to do that:
plugins:
- '@dotcom-tool-kit/next-router'
- '@dotcom-tool-kit/nodemon'
- '@dotcom-tool-kit/doppler'
hooks:
run:local:
- Nodemon
- NextRouter
options:
'@dotcom-tool-kit/next-router':
appName: appName # system's `name` field as it appears in next-service-registry
'@dotcom-tool-kit/doppler':
project: '[systemCode]' # corresponding doppler project name
Options
Key | Description | Default value | Required |
---|---|---|---|
appName | the system's name field as it appears in next-service-registry, which is often different to its code value so be sure to check) | ✅ |
Tasks
Task | Description | Default hooks |
---|---|---|
NextRouter | Run the application via the next-router | run:local |
2 days ago
2 days ago
3 days ago
3 months ago
4 months ago
5 months ago
5 months ago
5 months ago
6 months ago
10 months ago
7 months ago
8 months ago
6 months ago
6 months ago
7 months ago
7 months ago
11 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago