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: README.md
+7-18Lines changed: 7 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,6 @@ For detailed GP Connect specifications, see [GP Connect specifications for devel
17
17
-[Testing](#testing)
18
18
-[Design](#design)
19
19
-[CI/CD](#cicd)
20
-
-[Contributing](#contributing)
21
20
-[Licence](#licence)
22
21
23
22
## Architecture Overview
@@ -107,6 +106,8 @@ cd clinical-data-gateway-api
107
106
108
107
The project is configured to run inside a [Dev Container](https://containers.dev/) defined in `.devcontainer/devcontainer.json`. When you open the project in VS Code with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed, you will be prompted to reopen in the container. This automatically installs all required libraries and tools.
109
108
109
+
The dev container sits on the same network, `gateway-local`, as [the `gateway-api` container](infrastructure/README.md#docker-images), if deployed. Docker DNS will resolve <http://gateway-api> to the deployed Gateway API.
110
+
110
111
> [!NOTE]
111
112
> **Certificates:** If additional certificates are needed, add them to `infrastructure/images/build-container/resources/dev-certificates` and set the `INCLUDE_DEV_CERTS` Docker build argument to `true`.
112
113
>
@@ -147,10 +148,13 @@ The full API schema is defined in [gateway-api/openapi.yaml](gateway-api/openapi
147
148
148
149
| Variable | Description |
149
150
|---|---|
150
-
|`BASE_URL`| Protocol, hostname and port for the running API (e.g. `http://localhost:5000`) |
151
+
|`BASE_URL`| Protocol, hostname and port for the running API (e.g. `http://localhost:5000`, or `http://gateway-api:8080` from within the devcontainer) |
151
152
|`HOST`| hostname portion of `BASE_URL`|
152
153
|`FLASK_HOST`| Host the Flask app binds to |
153
154
|`FLASK_PORT`| Port the Flask app listens on |
155
+
|`STUB_PDS`|`true`, use the stubs/stubs/pds/stub.py to return stubbed responses for PDS FHIR API; otherwise, not. |
156
+
|`STUB_SDS`|`true`, use the stubs/stubs/sds/stub.py to return stubbed responses for SDS FHIR API; otherwise, not. |
157
+
|`STUB_PROVIDER`|`true`, use the stubs/stubs/provider/stub.py to return stubbed responses for the provider system; otherwise, not. |
154
158
155
159
Environment variables also control whether stubs are used in place of the real PDS, SDS, and Provider services during local development.
156
160
@@ -171,13 +175,9 @@ For detailed information about each test type, directory layout, and how to run
171
175
172
176
## Design
173
177
174
-
### Architecture Diagrams
175
-
176
-
Architecture diagrams follow the [C4 model](https://c4model.com/) and can be created using [draw.io](https://app.diagrams.net/) or [Mermaid](https://github.com/mermaid-js/mermaid).
177
-
178
178
### Stubs
179
179
180
-
The `gateway-api/stubs/` directory contains stub implementations of the external services (PDS, SDS, GP Provider). These are used during local development and testing so that tests can run without connecting to live NHS services. Stubs are activated via environment variables.
180
+
The `gateway-api/stubs/` directory contains stub implementations of the external services (PDS, SDS, GP Provider). These are used during local development and testing so that tests can run without connecting to live NHS services. Stubs are activated via [environment variables](#environment-variables).
181
181
182
182
### Architecture Decision Records
183
183
@@ -195,17 +195,6 @@ The project uses GitHub Actions for continuous integration and deployment, organ
195
195
196
196
For full details on each workflow and composite action, see the [CI/CD documentation](.github/github_actions.md).
197
197
198
-
## Contributing
199
-
200
-
Contributions are welcome. To get started:
201
-
202
-
1. Set up your development environment using the [Dev Container instructions](#dev-container-recommended) above
203
-
2. Ensure your commits are **signed** — see the [commit signing guide](https://github.com/NHSDigital/software-engineering-quality-framework/blob/main/practices/guides/commit-signing.md)
204
-
3. Run `make githooks-config` to enable pre-commit hooks for secret scanning and formatting checks
205
-
4. Open a pull request with a clear description of the change
206
-
207
-
Design decisions and their rationale are captured as Architecture Decision Records.
208
-
209
198
## Licence
210
199
211
200
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. See [LICENCE.md](./LICENCE.md).
0 commit comments