Skip to content

Commit 4791df9

Browse files
committed
Improve README readability and clarity
1 parent 382d05d commit 4791df9

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ jupyter-lite build --output-dir dist
4444

4545
Analysim requires two databases to operate: one SQL database (PostgreSQL) for relational data and one Azure BlobStorage database for keeping uploaded user files. In addition, an Outlook account is needed for the email functionality. All of these services are accessed via authentication information stored in the `appsettings.json` and `appsettings.Development.json` files under the `src/Analysim.Web` folder. The structure of the files are as follows (`XXX` means redacted):
4646

47+
1. Create `appsettings.json` and `appsettings.Development.json`
48+
49+
- Navigate to `src\Analysim.Web` folder in your cloned repository.
50+
- Create two files name `appsettings.json` and `appsettings.Development.json` if they do not exist.
51+
- Paste the following JSON structure into both files.
52+
4753
```json
4854
{
4955
"Logging": {
@@ -78,19 +84,19 @@ Analysim requires two databases to operate: one SQL database (PostgreSQL) for re
7884

7985
```
8086

81-
#### SQL database (also see Docker Compose option below)
87+
2. SQL database (also see Docker Compose option below)
8288

83-
If you don't have a SQL database yet, download and install [PostgreSQL](https://www.postgresql.org/download/). See the example for [installing on Ubuntu 22.04](https://linuxhint.com/install-and-setup-postgresql-database-ubuntu-22-04/). Create a user account ([tutorial](https://medium.com/coding-blocks/creating-user-database-and-adding-access-on-postgresql-8bfcd2f4a91e)) and replace the `XXX` values in the `DBConnectionString` above with the correct ones. Once you entered the correct details, you must be able to initialize and populate the database by using the Entity Framework migration tool by rinning the following command in the `src/Analysim.Web` folder:
89+
If you don't have a SQL database yet, download and install [PostgreSQL](https://www.postgresql.org/download/). See the example for [installing on Ubuntu 22.04](https://linuxhint.com/install-and-setup-postgresql-database-ubuntu-22-04/). Create a user account ([tutorial](https://medium.com/coding-blocks/creating-user-database-and-adding-access-on-postgresql-8bfcd2f4a91e)) and replace the `XXX` values in the `DBConnectionString` above with the correct ones. Once you entered the correct details, you must be able to initialize and populate the database by using the Entity Framework migration tool by running the following command in the `src/Analysim.Web` folder:
8490

8591
```
8692
dotnet ef database update
8793
```
8894

89-
#### Azure Blob Storage
95+
3. Azure Blob Storage
9096

9197
If you don't have an existing blob storage account, log into [Microsoft Azure](https://portal.azure.com), and create a ["Storage Account"](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview) with "Blob service" enabled. Then, select "Access Keys" on the left sidebar menu and copy one of the keys and insert both to replace the `XXX` in the `AzureStorageConnectionString` entry above. You will also need to insert your storage account name. In the same section on Azure, you can see the formatting for the correct Connection String as a guide. Blob storage falls under the [free student services](https://azure.microsoft.com/en-us/free/students/).
9298

93-
#### Outlook.com account
99+
4. Outlook.com account
94100

95101
You can either use an existing Outlook account or create a new one and then fill in the `XXX` values under the section `EmailSettings` in the above file.
96102

0 commit comments

Comments
 (0)