Skip to content

Commit 4af83fe

Browse files
committed
Merge branch 'main' of https://github.com/outshift-open/identity-service into fix/tests-ui
2 parents 1b46597 + cbc79c4 commit 4af83fe

1 file changed

Lines changed: 23 additions & 4 deletions

File tree

frontend/README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,26 @@ yarn install
4545

4646
## 🛠 Development Setup
4747

48-
### 1. Setup Node.js Version
48+
### 1. Generate PWA Assets (Logo Setup)
49+
50+
> **⚠️ IMPORTANT**
51+
> Before starting development, generate the PWA assets from your logo. This step sets up all the necessary icons and splash screens for your app.
52+
53+
```bash
54+
# Generate PWA assets from the logo.svg file
55+
yarn generate-pwa-assets
56+
```
57+
58+
This script will:
59+
60+
- Generate all required PWA icons (favicon, apple-touch-icon, etc.)
61+
- Create properly sized assets from your `public/logo.svg` file
62+
- Set up the visual identity for your Progressive Web App
63+
64+
> **📝 NOTE**
65+
> Make sure you have your custom logo as `public/logo.svg` before running this command.
66+
67+
### 2. Setup Node.js Version
4968

5069
```bash
5170
# Install NVM if you haven't already
@@ -59,7 +78,7 @@ nvm install
5978
nvm use
6079
```
6180

62-
### 2. Clone and Install Dependencies
81+
### 3. Clone and Install Dependencies
6382

6483
```bash
6584
# Clone the repository
@@ -70,7 +89,7 @@ cd identity-service/frontend
7089
yarn install
7190
```
7291

73-
### 3. Environment Configuration
92+
### 4. Environment Configuration
7493

7594
Create a `.env` file in the root directory:
7695

@@ -136,7 +155,7 @@ These options control:
136155
- **tabInactivityDuration**: Time in seconds before considering tab inactive
137156
- **syncStorage**: Whether to synchronize authentication state across browser tabs
138157

139-
### 4. Global Configuration Setup
158+
### 5. Global Configuration Setup
140159

141160
Configure the application's global settings by editing `src/config/global.ts`:
142161

0 commit comments

Comments
 (0)