@gov-cy/govcy-express-services 0.1.4 → 0.1.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/README.md +17 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,6 +14,8 @@
|
|
|
14
14
|
## 📝 Description
|
|
15
15
|
This project is an Express-based project that dynamically renders online service forms using `@gov-cy/govcy-frontend-renderer`. It is designed for developers building government services in Cyprus, enabling them to manage user authentication, form submissions, and OpenID authentication workflows in a timely manner.
|
|
16
16
|
|
|
17
|
+
The project is designed to support the [Linear structure](https://gov-cy.github.io/govcy-design-system-docs/patterns/service_structure/#variant-1---linear-structure) as described in the [Unified Design System](https://gov-cy.github.io/govcy-design-system-docs/).
|
|
18
|
+
|
|
17
19
|
|
|
18
20
|
|
|
19
21
|
## Table of contents
|
|
@@ -22,6 +24,7 @@ This project is an Express-based project that dynamically renders online service
|
|
|
22
24
|
- [✨ Features](#-features)
|
|
23
25
|
- [📋 Prerequisites](#-prerequisites)
|
|
24
26
|
- [🚀 Quick start](#-quick-start)
|
|
27
|
+
- [✅ Best Practices](#-best-practices)
|
|
25
28
|
- [📦 Full installation guide](#-full-installation-guide)
|
|
26
29
|
- [🛠️ Usage](#%EF%B8%8F-usage)
|
|
27
30
|
- [🧩 Dynamic services rendering](#-dynamic-services-rendering)
|
|
@@ -97,6 +100,15 @@ For more details on configuration, environment variables, and advanced features,
|
|
|
97
100
|
## 📦 Full installation guide
|
|
98
101
|
The project acts as an npm package and you need to install it as a dependency in your npm project. Check out the [install notes](INSTALL-NOTES.md) a detailed installation guide.
|
|
99
102
|
|
|
103
|
+
## ✅ Best Practices
|
|
104
|
+
|
|
105
|
+
Before starting your service, please review the [Best Practices guide](BEST-PRACTICES.md) for guidance on:
|
|
106
|
+
|
|
107
|
+
- Repository structure
|
|
108
|
+
- Environment separation (`dev` / `staging` / `prod`)
|
|
109
|
+
- Secure CY Login client registration
|
|
110
|
+
- Mandatory footer pages (privacy, cookies, accessibility)
|
|
111
|
+
|
|
100
112
|
## 🛠️ Usage
|
|
101
113
|
### Starting the Server
|
|
102
114
|
Add in your `package.json`:
|
|
@@ -281,6 +293,11 @@ Lets break down the JSON config for this page:
|
|
|
281
293
|
- Not perform the eligibility checks
|
|
282
294
|
- Display the static content
|
|
283
295
|
|
|
296
|
+
When designing form pages, refer to the Unified Design System's [question pages pattern](https://gov-cy.github.io/govcy-design-system-docs/patterns/question_pages/).
|
|
297
|
+
|
|
298
|
+
**Error pages**
|
|
299
|
+
Pages that can be used to display messages when eligibility or submission fail are simply static content pages. That is pages that do not include a `form` element.
|
|
300
|
+
|
|
284
301
|
**Notes**:
|
|
285
302
|
- Check out the [govcy-frontend-renderer's design elements](https://github.com/gov-cy/govcy-frontend-renderer/blob/main/DESIGN_ELEMENTS.md) for more details on the supported elements and their parameters.
|
|
286
303
|
- Check out the [input validations section](#-input-validations) for more details on how to add validations to the JSON file.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gov-cy/govcy-express-services",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.5",
|
|
4
4
|
"description": "An Express-based system that dynamically renders services using @gov-cy/govcy-frontend-renderer and posts data to a submission API.",
|
|
5
5
|
"author": "DMRID - DSF Team",
|
|
6
6
|
"license": "MIT",
|