You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/GETTING_STARTED.md
+31-7Lines changed: 31 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -102,11 +102,39 @@ await server.start()
102
102
103
103
## Step 3: Handling static assets
104
104
105
-
TODO
105
+
1.[Update webpack to bundle the DXT application assets (CSS, JavaScript, etc)](https://github.com/DEFRA/forms-engine-plugin-example-ui/pull/1/files#diff-1fb26bc12ac780c7ad7325730ed09fc4c2c3d757c276c3dacc44bfe20faf166f)
106
+
2.[Serve the newly bundled assets from your web server](https://github.com/DEFRA/forms-engine-plugin-example-ui/pull/1/files#diff-e5b183306056f90c7f606b526dbc0d0b7e17bccd703945703a0811b6e6bb3503)
107
+
108
+
DXT plans to prefix to these asset paths to prevent collisions with your assets. Contact [#defra-forms-support](https://defra-digital-team.slack.com) if this is a blocker for you.
106
109
107
110
## Step 4: Environment variables
108
111
109
-
TODO
112
+
Blocks marked with `# FEATURE: <name>` are optional and can be omitted if the feature is not used.
113
+
114
+
```shell
115
+
# START FEATURE: Phase banner -- supports `https://` and `mailto:` links in the feedback link
116
+
FEEDBACK_LINK=http://test.com
117
+
# END FEATURE: Phase banner
118
+
119
+
# START FEATURE: DXT -- used if using DXT's infrastructure to store your forms and file uploads
120
+
MANAGER_URL=http://localhost:3001
121
+
DESIGNER_URL=http://localhost:3000
122
+
SUBMISSION_URL=http://localhost:3002
123
+
124
+
# S3 bucket and URL of the CDP uploader. Bucket is owned by DXT, uploader is your service's URL.
125
+
UPLOADER_BUCKET_NAME=my-bucket
126
+
UPLOADER_URL=http://localhost:7337
127
+
# END FEATURE: DXT
128
+
129
+
# START FEATURE: GOV.UK Notify -- used if using DXT's default GOV.UK Notify email sender
130
+
NOTIFY_TEMPLATE_ID="your-gov-notify-api-key"
131
+
NOTIFY_API_KEY="your-gov-notify-api-key"
132
+
# END FEATURE: GOV.UK Notify
133
+
134
+
# START FEATURE: Google Analytics -- if enabled, shows a cookie banner and includes GA on the cookies/privacy policy
135
+
GOOGLE_ANALYTICS_TRACKING_ID='12345'
136
+
# END FEATURE: Google Analytics
137
+
```
110
138
111
139
## Step 5: Creating and loading a form
112
140
@@ -120,8 +148,4 @@ These files are called `Form definitions` and are built up of:
120
148
-`conditions` - used to conditionally show and hide pages and
121
149
-`lists` - data used to in selection fields like [Select](https://design-system.service.gov.uk/components/select/), [Checkboxes](https://design-system.service.gov.uk/components/checkboxes/) and [Radios](https://design-system.service.gov.uk/components/radios/)
122
150
123
-
The [types](https://github.com/DEFRA/forms-designer/blob/main/model/src/form/form-definition/types.ts), `joi`[schema](https://github.com/DEFRA/forms-designer/blob/main/model/src/form/form-definition/index.ts) and the [examples](test/form/definitions) folder are a good place to learn about the structure of these files.
124
-
125
-
TODO - Link to wiki for `Form metadata`
126
-
127
-
TODO - Link to wiki for `Form definition`
151
+
To understand the full set of options available to you, consult our [schema documentation](https://defra.github.io/forms-engine-plugin/schemas/). Specifically, the [form definition schema](https://defra.github.io/forms-engine-plugin/schemas/form-definition-v2-payload-schema).
Copy file name to clipboardExpand all lines: docs/features/code-based/PAGE_VIEWS.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,7 @@
1
1
# Templates and views
2
2
3
-
## Extending the default layout
4
-
5
-
TODO
3
+
> [!NOTE]
4
+
> DXT currently handles the page layout internally within the plugin and cannot be customised. We plan to offer this customisation as a feature, please contact us on Slack if this is urgent for you.
6
5
7
6
To override the default page template, vision and nunjucks both need to be configured to search in the `forms-engine-plugin` views directory when looking for template files.
0 commit comments