Skip to content

Commit ac8a5ad

Browse files
committed
fix: DEVELOP file with Markdown rendering and Rust version command (#25)
Closes #25 Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>
1 parent 8524d07 commit ac8a5ad

1 file changed

Lines changed: 32 additions & 17 deletions

File tree

DEVELOP renamed to DEVELOP.md

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,19 @@
22

33
## ⚡ Quick Start
44

5+
```bash
56
git clone https://github.com/stephanebouget/github-security-alerts.git
7+
```
8+
9+
```bash
610
cd github-security-alerts
7-
npm install
8-
npm start
11+
```
912

10-
The application should open automatically via Tauri.
13+
```bash
14+
npm install && npm start
15+
```
1116

12-
---
17+
The application should open automatically via Tauri.
1318

1419
## 🧰 Requirements
1520

@@ -24,40 +29,51 @@ https://v2.tauri.app/start/prerequisites
2429

2530
Check versions:
2631

32+
```bash
2733
node -v
34+
```
35+
36+
```bash
2837
npm -v
29-
rustc -v
38+
```
39+
40+
```bash
41+
rustc -V
42+
```
3043

31-
---
3244

3345
## 🧑‍💻 Development Mode
3446

3547
### Run full app (Tauri)
3648

49+
```bash
3750
npm start
51+
```
3852

3953
- Launches the desktop app via Tauri
4054
- Includes backend (Rust) + frontend (Angular)
4155

42-
---
43-
4456
### Run frontend only (faster)
4557

58+
```bash
4659
npm run web:serve
60+
```
4761

4862
- Runs Angular in browser
4963
- Hot reload enabled
5064
- Recommended for UI development
5165

52-
---
5366

5467
## 🧪 Tests
5568

5669
Run tests:
5770

71+
```bash
5872
npm test
73+
```
5974

60-
⚠️ Note: Test coverage is currently limited. Contributions are welcome.
75+
> [!NOTE]
76+
> Test coverage is currently limited. Contributions are welcome.
6177
6278
---
6379

@@ -68,15 +84,17 @@ npm test
6884

6985
Enable verbose logs:
7086

87+
```bash
7188
RUST_LOG=debug npm start
72-
73-
---
89+
```
7490

7591
## 📦 Build
7692

7793
### Web build
7894

95+
```bash
7996
npm run web:prod
97+
```
8098

8199
Output:
82100
/dist
@@ -85,21 +103,20 @@ Output:
85103

86104
### Desktop app (Tauri)
87105

106+
```bash
88107
npm run tauri:bundle
108+
```
89109

90110
Output:
91111
src-tauri/target/release/bundle/
92112

93-
---
94-
95113
## 📁 Project Structure
96114

97115
| Folder | Description |
98116
| --------- | ----------------------------------- |
99117
| src | Angular frontend (renderer process) |
100118
| src-tauri | Tauri backend (Rust main process) |
101119

102-
---
103120

104121
## 🔄 Development Workflow
105122

@@ -109,8 +126,6 @@ src-tauri/target/release/bundle/
109126
4. Ensure everything builds correctly
110127
5. Submit a Pull Request
111128

112-
---
113-
114129
## ℹ️ Notes
115130

116131
- Only the `/dist` folder is included in the final bundle

0 commit comments

Comments
 (0)