@@ -27,8 +27,11 @@ This repository documents the Supplier API specification and provides an SDK wit
2727 - [ Examples] ( #examples )
2828 - [ API Developers] ( #api-developers )
2929 - [ Documentation] ( #documentation-1 )
30+ - [ pre built servers] ( #pre-built-servers )
3031 - [ Setup] ( #setup )
3132 - [ Prerequisites and Configuration] ( #prerequisites-and-configuration )
33+ - [ SDKs] ( #sdks )
34+ - [ Servers] ( #servers )
3235 - [ Build] ( #build )
3336 - [ GitHub Actions CI/CD] ( #github-actions-cicd )
3437 - [ CI (Automatic)] ( #ci-automatic )
@@ -76,19 +79,32 @@ should understand the below.
7679- [ Built] ( / )
7780- [ Source] ( /docs/README.md )
7881
82+ ### pre built servers
83+
84+ - Docker (csharp) ` docker run -p 3000:3000 ghcr.io/nhsdigital/nhsnotifysupplierserver:latest `
85+ - CSharp ` server-csharp-[Version].zip `
86+
7987### Setup
8088
8189#### Prerequisites and Configuration
8290
8391- Utilised the devcontainer, for pre reqs and configuration.
8492- You should open in a devcontainer or a Github workspaces.
8593- By default it will run ` make config ` when the container is first setup
94+
95+ ##### SDKs
96+
8697- The [ SDK] ( sdk ) folder is excluded from all pre reqs
8798- DO NOT make manual changes to the [ SDK] ( sdk ) , instead [ build] ( #build ) it
8899- The SDK folder is excluded from git commits,
89100 and will be built as part of the CI/CD pipeline and released as a GitHub
90101 release.
91102
103+ ##### Servers
104+
105+ - Servers folder is being built at build time from OAS specs.
106+ - TODO: Build actual servers
107+
92108### Build
93109
94110To generate the SDK folder from changes to the [ specification/api/notify-supplier.yml] ( specification/api/notify-supplier.yml ) OAS specification:
0 commit comments