Skip to content

Commit

Permalink
Update developer setup notes (#1706)
Browse files Browse the repository at this point in the history
  • Loading branch information
gunndabad authored Nov 25, 2024
1 parent b413506 commit b71fc42
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ terraform/domains/environment_domains/vendor/
terraform/domains/infrastructure/vendor/
terraform/aks/vendor/
bin/konduit.sh

.idea
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,23 +68,32 @@ See the [changelog](CHANGELOG.md) for the details of what has changed between ve

The API is an ASP.NET Core 8 web application. To develop locally you will need the following installed:
- Visual Studio 2022 (or the .NET 8 SDK and an alternative IDE/editor);
- a local Postgres 13+ instance.
- [SASS]( https://sass-lang.com/install).
- a local Postgres 15+ instance;
- NPM.

A `justfile` defines various recipes for development. Ensure [just](https://just.systems/) is installed and available on your `$PATH` as well as [PowerShell](https://microsoft.com/PowerShell).

If you're working on infrastructure you will also need:
- make;
- Terraform;
- Azure CLI;
- bash.

### Local tools setup

dotnet-format is required for linting. A `just` recipe will install it:
A `just` recipe will install the required local tools:
```shell
just install-tools
```

### Restore dependencies

As well as NuGet packages, there are some client-side libraries required. A `just` recipe will install both:
```shell
just restore
```


### Database setup

Install Postgres then set a connection string configuration entry in user secrets for running the apps and another for running the tests.
Expand All @@ -107,8 +116,8 @@ The databases will be created automatically when running the tests.
#### DQT Reporting database setup

This solution contains a service that synchronises changes from CRM into a SQL Server database used for reporting (this replaces the now-deprecated Data Export Service).
It also synronises selected tables from TRS.
By default this is disabled for local development. For the tests to pass, you will need a test database and a connection string defined in user secrets e.g.
It also synchronises selected tables from TRS.
By default, this is disabled for local development. For the tests to pass, you will need a test database and a connection string defined in user secrets e.g.
```shell
just set-tests-secret DqtReporting:ReportingDbConnectionString "Data Source=(local);Initial Catalog=DqtReportingTests;Integrated Security=Yes;TrustServerCertificate=True"
```
Expand Down

0 comments on commit b71fc42

Please sign in to comment.