https://github.com/defra/assurance-api
Git repository for service assurance-api
https://github.com/defra/assurance-api
backend cdp dotnet service
Last synced: 2 months ago
JSON representation
Git repository for service assurance-api
- Host: GitHub
- URL: https://github.com/defra/assurance-api
- Owner: DEFRA
- License: other
- Created: 2025-02-03T14:17:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-03T20:35:44.000Z (about 1 year ago)
- Last Synced: 2025-06-03T22:43:20.259Z (about 1 year ago)
- Topics: backend, cdp, dotnet, service
- Language: C#
- Size: 119 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# assurance-api
Core delivery C# ASP.NET backend template.
* [Install MongoDB](#install-mongodb)
* [Inspect MongoDB](#inspect-mongodb)
* [Testing](#testing)
* [Running](#running)
* [Dependabot](#dependabot)
### Install MongoDB
- Install [MongoDB](https://www.mongodb.com/docs/manual/tutorial/#installation) on your local machine
- Start MongoDB:
```bash
sudo mongod --dbpath ~/mongodb-cdp
```
### Inspect MongoDB
To inspect the Database and Collections locally:
```bash
mongosh
```
### Testing
Run the tests with:
Tests run by running a full `WebApplication` backed by [Ephemeral MongoDB](https://github.com/asimmon/ephemeral-mongo).
Tests do not use mocking of any sort and read and write from the in-memory database.
```bash
dotnet test
````
### Running
Run CDP-Deployments application:
```bash
dotnet run --project AssuranceApi --launch-profile Development
```
### SonarCloud
Example SonarCloud configuration are available in the GitHub Action workflows.
### Dependabot
We have added an example dependabot configuration file to the repository. You can enable it by renaming
the [.github/example.dependabot.yml](.github/example.dependabot.yml) to `.github/dependabot.yml`