Skip to content

Commit

Permalink
Remove mention of in-mem DB from README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
TheTedder committed Aug 15, 2023
1 parent db89b12 commit 4711616
Showing 1 changed file with 0 additions and 9 deletions.
9 changes: 0 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,6 @@ cp example.env .env
```

### Running the Database(s)
We use Postgres, but have the ability to run Entity Framework's in-memory DB as well instead, which allows quicker debugging.

**Running with Postgres is highly encouraged**, as the in-memory DB will not behave the same as Postgres,
and [some features will not work at all](https://learn.microsoft.com/en-us/ef/core/testing/choosing-a-testing-strategy#in-memory-as-a-database-fake) (for example: transactions and constraints).

#### Postgres with Docker compose
As mentioned above, we run Docker containers for the DB. After [installing Docker Compose](https://docs.docker.com/compose/install/), run this command in the project root:
Expand All @@ -101,9 +97,6 @@ If you're using the default values provided in `example.env`, input these values
| Password | `example` | Corresponds to `ApplicationContext__PG__PASSWORD`
| Database | `leaderboardsmain` | Corresponds to `ApplicationContext__PG__DB`

#### In-memory database
To use the in-memory database, set `ApplicationContext__UseInMemoryDb` in your `.env` file to `true`.

### Visual Studio

#### First Time Setup
Expand Down Expand Up @@ -158,8 +151,6 @@ dotnet run # or `dotnet watch` to run with hot reload

#### Test the App
Docker is required to run integration tests against a real Postgres database.
However, if you would still like to run the tests with an in-memory database, you can set the following environment variable: `INTEGRATION_TESTS_DB_BACKEND=InMemory`.

To run the tests, run the following commands from the root of the repository:

```bash
Expand Down

0 comments on commit 4711616

Please sign in to comment.