Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Danny-UKDM committed Apr 2, 2019
1 parent 869981a commit 8b6af01
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# .Net Core Web Api

[![Build status](https://ci.appveyor.com/api/projects/status/rlou2yhasuj4h1tl/branch/master?svg=true)](https://ci.appveyor.com/project/Danny-UKDM/dotnetcore-webapi/branch/master)

[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/b7a76145125d646477c7)
[![Build status](https://ci.appveyor.com/api/projects/status/rlou2yhasuj4h1tl/branch/master?svg=true)](https://ci.appveyor.com/project/Danny-UKDM/dotnetcore-webapi/branch/master)

Just playing with a .Net Core 2.2 Web Api

Expand All @@ -13,7 +11,7 @@ These instructions will get you a copy of the solution up and running on your lo
### Prerequisites

* [.NET Core SDK 2.2](https://dotnet.microsoft.com/download/dotnet-core/2.2)
* [PostgreSQL 9.5](https://www.postgresql.org/download/) (superuser with password: `password` & port: `5432`)
* [Docker](https://docs.docker.com/docker-for-windows/)

### Using The Solution

Expand All @@ -23,13 +21,19 @@ In a terminal window in the root of the solution;

* Build the solution by using the `dotnet build` command.

* Run all tests by using the `dotnet test` command.
* To run all tests, including integration tests;

1. Provision the LocalStack and PostgreSQL resources by using the `docker-compose up -d` command.
2. Run all tests by using the `dotnet test` command.

* To run the Web API project locally;

* Run the Web API project locally by using the `dotnet run --project WebApi/WebApi.csproj` command.
1. Provision the LocalStack and PostgreSQL resources by using the `docker-compose up -d` command.
2. Run the application by using the `dotnet run --project WebApi/WebApi.csproj` command.

Running the Web API project locally will create a local test PostgreSQL database and table; before making the HTTP endpoints available.
Running the Web API project locally will create a local test S3 Bucket, PostgreSQL database and table; before making the HTTP endpoints available.

On application close (`ctrl` + `c` from the terminal window), the test database will be dropped and the connection disposed of.
On application close (`ctrl` + `c` from the terminal window), the test database will be dropped and the S3 bucket, destroyed.

### Swagger

Expand All @@ -38,6 +42,8 @@ This project uses [Swagger](https://github.com/domaindrivendev/Swashbuckle.AspNe
## Built With

* [.Net Core Web API](https://docs.microsoft.com/en-us/aspnet/core/web-api/) - Framework
* [Docker](https://docs.docker.com/docker-for-windows/) - Infrastructure
* [LocalStack](https://github.com/localstack/localstack) - Local AWS Cloud Stack
* [Badger.Data](https://github.com/timbarker/Badger.Data) - Data Access
* [Xunit](https://xunit.github.io/) / [Fluent Assertions](https://fluentassertions.com/) - Test Framework

Expand Down

0 comments on commit 8b6af01

Please sign in to comment.