Skip to content

Commit e0ecf78

Browse files
authored
Configure readme's (#8)
1 parent c6f978a commit e0ecf78

2 files changed

Lines changed: 19 additions & 15 deletions

File tree

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
11
HMPPS CFO DMS
22
=============
33

4-
5-
HMPPS CFO DMS
6-
=============
7-
84
HMPPS Creating Future Opportunities (CFO) - Data Management System (DMS). It is intended for internal use only and is used to process PNOMIS and NDelius offender data to supply CATS (Case Assessment and Tracking System - also used by HMPPS CFO) with accurate offender movements and updates.
95

106
# Queries
117

128
Any queries, please contact andrew.grocott@justice.gov.uk or visit our slack channel. https://app.slack.com/client/T02DYEB3A/C011Z8PGWCU/details/
139

10+
# Development Setup and Execution Guide
11+
12+
## Setup (development)
13+
1. From the **project root**, run the setup script. This will automatically create the required folder structure in your devices home directory:
14+
```sh
15+
./setup.sh
16+
```
17+
2. Configure secret(s) for applications in the *src* directory:
18+
- *Visualiser.csproj* → Manage User Secrets
19+
```json
20+
{
21+
"AzureAd:ClientSecret": "<ENTRA_CLIENT_SECRET>"
22+
}
23+
```
1424

25+
## Running the apps
26+
The recommended way to run and debug these apps is using .NET Aspire.
27+
- **Using Visual Studio Code**: open the project and press `F5`, selecting the *Default Configuration*.
28+
- **Using Visual Studio or other IDEs**: From the debug configuration dropdown, select `Aspire.AppHost` and start the application.

src/Visualiser/README.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,21 +58,11 @@ visit the #staff-identity-authentication-services channel in Slack and complete
5858
- Admin consent display name: *Write to API*
5959
- User consent display name: *Write to API*
6060
- State: *Enabled*
61-
10. (optional) Add App Roles (for app-only / service-to-service)
62-
- App registrations → your api → App roles → Create app role
63-
- Display name: `Api.Read.All`
64-
- Allowed member types: Applications
65-
- Value: `Api.Read.All`
66-
- Description: *Can read from the API*
67-
- Do the same for `API.Write.All`
68-
11. Grant the web app access to the API
61+
10. Grant the web app access to the API
6962
- App Registrations → API Permissions → Add a permission → My APIs → *your_api*
7063
- **Delegated permissions**:
7164
- [x] `api.read`
7265
- [x] `api.write`
73-
- **Application permissions** (optional):
74-
- [x] `Api.Read.All`
75-
- [x] `Api.Write.All`
7666
- App registrations → *your_api* → Expose an API → Authorized client applications → Add a client application
7767
- Client ID: *enter the Application (Client) ID of the web application*
7868
- Authorized scopes: **select all**

0 commit comments

Comments
 (0)