github-security-alerts/DEVELOP at main · stephanebouget/github-security-alerts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# Development Guide

## ⚡ Quick Start

git clone https://github.com/stephanebouget/github-security-alerts.git
cd github-security-alerts
npm install
npm start

The application should open automatically via Tauri.

---

## 🧰 Requirements

Make sure you have the following installed:

- Node.js >= 22
- npm >= 10
- Rust (stable)

Tauri prerequisites:
https://v2.tauri.app/start/prerequisites

Check versions:

node -v
npm -v
rustc -v

---

## 🧑‍💻 Development Mode

### Run full app (Tauri)

npm start

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

---

### Run frontend only (faster)

npm run web:serve

- Runs Angular in browser
- Hot reload enabled
- Recommended for UI development

---

## 🧪 Tests

Run tests:

npm test

⚠️ Note: Test coverage is currently limited. Contributions are welcome.

---

## 🐛 Debugging

- Frontend logs → Browser devtools
- Backend logs → Terminal running the app

Enable verbose logs:

RUST_LOG=debug npm start

---

## 📦 Build

### Web build

npm run web:prod

Output:
/dist

---

### Desktop app (Tauri)

npm run tauri:bundle

Output:
src-tauri/target/release/bundle/

---

## 📁 Project Structure

| Folder    | Description                         |
| --------- | ----------------------------------- |
| src       | Angular frontend (renderer process) |
| src-tauri | Tauri backend (Rust main process)   |

---

## 🔄 Development Workflow

1. Create a branch from `main`
2. Make your changes
3. Run the app locally
4. Ensure everything builds correctly
5. Submit a Pull Request

---

## ℹ️ Notes

- Only the `/dist` folder is included in the final bundle
- Prefer `web:serve` for frontend work to improve speed