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
+9-114Lines changed: 9 additions & 114 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,21 +9,19 @@ It models the concepts needed to configure production of letters and other print
9
9
10
10
This repository documents the Supplier API specification and provides an SDK with examples and reference client implementations for interacting with it.
-[Prerequisites and Configuration](#prerequisites-and-configuration)
27
25
-[Licence](#licence)
28
26
29
27
## Documentation
@@ -33,112 +31,9 @@ This repository documents the Supplier API specification and provides an SDK wit
33
31
34
32
## Setup
35
33
36
-
> TODO
37
-
38
-
By including preferably a one-liner or if necessary a set of clear CLI instructions we improve user experience. This should be a frictionless installation process that works on various operating systems (macOS, Linux, Windows WSL) and handles all the dependencies.
The following software packages, or their equivalents, are expected to be installed and configured:
52
-
53
-
-[Docker](https://www.docker.com/) container runtime or a compatible tool, e.g. [Podman](https://podman.io/),
54
-
-[asdf](https://asdf-vm.com/) version manager,
55
-
-[GNU make](https://www.gnu.org/software/make/) 3.82 or later,
56
-
57
-
> [!NOTE]<br>
58
-
> The version of GNU make available by default on macOS is earlier than 3.82. You will need to upgrade it or certain `make` tasks will fail. On macOS, you will need [Homebrew](https://brew.sh/) installed, then to install `make`, like so:
59
-
>
60
-
> ```shell
61
-
> brew install make
62
-
>```
63
-
>
64
-
> You will then see instructions to fix your [`$PATH`](https://github.com/nhs-england-tools/dotfiles/blob/main/dot_path.tmpl) variable to make the newly installed version available. If you are using [dotfiles](https://github.com/nhs-england-tools/dotfiles), this is all donefor you.
65
-
66
-
- [GNU sed](https://www.gnu.org/software/sed/) and [GNU grep](https://www.gnu.org/software/grep/) are required for the scripted command-line output processing,
67
-
- [GNU coreutils](https://www.gnu.org/software/coreutils/) and [GNU binutils](https://www.gnu.org/software/binutils/) may be required to build dependencies like Python, which may need to be compiled during installation,
68
-
69
-
> [!NOTE]<br>
70
-
> For macOS users, installation of the GNU toolchain has been scripted and automated as part of the `dotfiles` project. Please see this [script](https://github.com/nhs-england-tools/dotfiles/blob/main/assets/20-install-base-packages.macos.sh) for details.
71
-
72
-
- [Python](https://www.python.org/) required to run Git hooks,
73
-
- [`jq`](https://jqlang.github.io/jq/) a lightweight and flexible command-line JSON processor.
74
-
75
-
### Configuration
76
-
77
-
> TODO
78
-
79
-
Installation and configuration of the toolchain dependencies
80
-
81
-
```shell
82
-
make config
83
-
```
84
-
85
-
## Usage
86
-
87
-
> TODO
88
-
89
-
After a successful installation, provide an informative example of how this project can be used. Additional code snippets, screenshots and demos work well in this space. You may also link to the other documentation resources, e.g. the [User Guide](./docs/user-guide.md) to demonstrate more use cases and to show more features.
90
-
91
-
### Testing
92
-
93
-
> TODO
94
-
95
-
There are `make` tasks for you to configure to run your tests. Run `make test` to see how they work. You should be able to use the same entry points for local development as in your CI pipeline.
96
-
97
-
## Design
98
-
99
-
### Diagrams
100
-
101
-
> TODO
102
-
103
-
The [C4 model](https://c4model.com/) is a simple and intuitive way to create software architecture diagrams that are clear, consistent, scalable and most importantly collaborative. This should result in documenting all the system interfaces, external dependencies and integration points.
The source for diagrams should be in Git for change control and review purposes. Recommendations are [draw.io](https://app.diagrams.net/) (example above in [docs](.docs/diagrams/) folder) and [Mermaids](https://github.com/mermaid-js/mermaid). Here is an example Mermaids sequence diagram:
108
-
109
-
```mermaid
110
-
sequenceDiagram
111
-
User->>+Service: GET /users?params=...
112
-
Service->>Service: auth request
113
-
Service->>Database: get all users
114
-
Database-->>Service: list of users
115
-
Service->>Service: filter users
116
-
Service-->>-User: list[User]
117
-
```
118
-
119
-
### Modularity
120
-
121
-
> TODO
122
-
123
-
Most of the projects are built with customisability and extendability in mind. At a minimum, this can be achieved by implementing service level configuration options and settings. The intention of this section is to show how this can be used. If the system processes data, you could mention here for example how the input is prepared for testing - anonymised, synthetic or live data.
124
-
125
-
## Contributing
126
-
127
-
> TODO
128
-
129
-
Describe or link templates on how to raise an issue, feature request or make a contribution to the codebase. Reference the other documentation files, like
130
-
131
-
- Environment setup for contribution, i.e. `CONTRIBUTING.md`
132
-
- Coding standards, branching, linting, practices for development and testing
133
-
- Release process, versioning, changelog
134
-
- Backlog, board, roadmap, ways of working
135
-
- High-level requirements, guiding principles, decision records, etc.
136
-
137
-
## Contacts
138
-
139
-
> TODO
34
+
### Prerequisites and Configuration
140
35
141
-
Provide a way to contact the owners of this project. It can be a team, an individual or information on the means of getting in touch via active communication channels, e.g. opening a GitHub discussion, raising an issue, etc.
36
+
Utilised the devcontainer, for pre reqs and configuration.
0 commit comments