Skip to content

chore: update readme #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Povindu wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: update readme #322

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d968671
chore: update readme
Povindu Oct 21, 2025
4e6c602
Merge branch 'main' into chore/povindu/update-readme
Povindu Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,23 @@ If a repository folder already exists, script will fetch and reset it to the lat
```


### 4. Run Development Servers
### 4. Setup Azure CLI and KeyVault name

Before running the application, ensure the following configuration is properly set:

1. Update appsettings.json:

- Locate the keyVaultName attribute in your appsettings.json.
- Replace its value with the correct Azure Key Vault name (for example: "docs-keyVault").
- This allows the application to securely retrieve secrets (such as connection strings or API keys) from Azure Key Vault instead of storing them locally.

2. Set up Azure CLI:

- Install and sign in to Azure CLI using `az login`
- Ensure you have access to the correct subscription and Key Vault.


### 5. Run Development Servers

#### Backend (with API and proxy to frontend)

Expand Down Expand Up @@ -83,7 +99,7 @@ To manage the content during development, npm command to run dev server with red
npm run dev:partial
```

### 5. Run Production Build
### 6. Run Production Build

1. Build Backend (includes frontend)

Expand Down