|
1 | | -[](https://angular.io/) <img src="https://raw.githubusercontent.com/gilbarbara/logos/master/logos/tauri.svg" width="50"> |
| 1 | +# GitHub Security Alerts |
2 | 2 |
|
3 | | -![Maintained][maintained-badge] |
4 | | -[![Make a pull request][prs-badge]][prs] |
5 | | -[![License][license-badge]](LICENSE.md) |
| 3 | +A modern desktop application that monitors security vulnerabilities across your GitHub repositories in real-time. Built with Angular and Rust/Tauri for a lightweight, performant experience. |
6 | 4 |
|
7 | | -[![Build][tauri-build-badge]][tauri-build] |
| 5 | + |
8 | 6 |
|
9 | | -[![Watch on GitHub][github-watch-badge]][github-watch] |
10 | | -[![Star on GitHub][github-star-badge]][github-star] |
11 | | -[![Tweet][twitter-badge]][twitter] |
| 7 | +## 📋 Features |
12 | 8 |
|
13 | | -# Introduction |
| 9 | +### Core Functionality |
14 | 10 |
|
15 | | -Bootstrap and package your project with Angular 21 (Typescript + SASS + Hot Reload) and Tauri (Rust) for creating Desktop applications. |
| 11 | +- **Real-time Security Monitoring**: Track Dependabot security alerts across all your repositories |
| 12 | +- **Repository Management**: Select and manage which repositories to monitor |
| 13 | +- **GitHub Integration**: Seamless authentication via GitHub personal access tokens |
| 14 | +- **System Tray Integration**: Minimize to system tray with icon status indicators |
| 15 | +- **Auto-refresh**: Automatic alert updates every hour (configurable) |
16 | 16 |
|
17 | | -Currently runs with: |
| 17 | +## ⚠️ Prerequisites |
18 | 18 |
|
19 | | -- Angular v21.0.3 |
20 | | -- Tauri 2.1.1 |
| 19 | +**GitHub Advanced Security Features** |
| 20 | +For this application to function properly, GitHub Advanced Security features must be enabled on the repositories you want to monitor: |
21 | 21 |
|
22 | | -With this sample, you can: |
| 22 | +- Dependabot alerts must be activated |
| 23 | +- Security advisories should be enabled |
| 24 | +- For private repositories, you may need a GitHub Enterprise or GitHub Advanced Security license |
23 | 25 |
|
24 | | -- Run your app in a local development environment with Tauri & Hot reload |
25 | | -- Run your app in a production environment |
26 | | -- Package your app into an executable file for Linux, Windows & Mac |
| 26 | +## 🎯 Usage Guide |
27 | 27 |
|
28 | | -/!\ Angular CLI needs Node 22 or later to work correctly. |
| 28 | +### First Launch |
29 | 29 |
|
30 | | -## Getting Started |
| 30 | +1. **Authenticate** |
31 | 31 |
|
32 | | -*Clone this repository locally:* |
| 32 | + - Paste your GitHub personal access token in the login form |
| 33 | + - The app validates the token and saves it securely |
33 | 34 |
|
34 | | -``` bash |
35 | | -git clone https://github.com/maximegris/angular-tauri.git |
36 | | -``` |
| 35 | +2. **Select Repositories** |
37 | 36 |
|
38 | | -*Install Tauri (Rust)* |
| 37 | + - Click the "📦 Repositories" button in the header |
| 38 | + - Expand owners (users/organizations) to see their repositories |
| 39 | + - Select repositories you want to monitor |
| 40 | + - Click "✓ Done - View Alerts" |
39 | 41 |
|
40 | | -https://tauri.studio/docs/getting-started/prerequisites |
| 42 | +3. **View Alerts** |
| 43 | + - The main "Alerts" view shows a summary of total security alerts |
| 44 | + - Each repository displays its alert count |
| 45 | + - Click any repository to open it on GitHub in your browser |
| 46 | + - Checkmark (✓) indicates no alerts, numbers show active alerts |
41 | 47 |
|
42 | | -*Install dependencies with npm:* |
| 48 | +## 📝 License |
43 | 49 |
|
44 | | -``` bash |
45 | | -npm install |
46 | | -``` |
47 | | - |
48 | | -If you want to generate Angular components with Angular-cli , you **MUST** install `@angular/cli` in npm global context. |
49 | | -Please follow [Angular-cli documentation](https://github.com/angular/angular-cli) if you had installed a previous version of `angular-cli`. |
50 | | - |
51 | | -``` bash |
52 | | -npm install -g @angular/cli |
53 | | -``` |
54 | | - |
55 | | -Older @angular/cli references may grab angular version 18. To update to angular version 21 specifically for the global cli run: |
56 | | - |
57 | | -``` bash |
58 | | -npm install -g @angular/cli@^21 |
59 | | -``` |
60 | | - |
61 | | -## To build for development |
62 | | - |
63 | | -- **in a terminal window** -> npm start |
64 | | - |
65 | | -Voila! You can use your Angular + Tauri app in a local development environment with hot reload! |
66 | | - |
67 | | -The application code is managed by `src-tauri/main.rs`. \ |
68 | | -In this sample, the app runs with a simple Angular App (http://localhost:4200), and a webView managed by Tauri. |
69 | | - |
70 | | -## Project structure |
71 | | - |
72 | | -| Folder | Description | |
73 | | -|-----------|-----------------------------------------------| |
74 | | -| src-tauri | Tauri main process folder (Rust) | |
75 | | -| src | Tauri renderer process folder (Web / Angular) | |
76 | | - |
77 | | -## Browser mode |
78 | | - |
79 | | -Maybe you only want to execute the application in the browser with hot reload? Just run `npm run web:serve`. |
80 | | - |
81 | | -## Included Commands |
82 | | - |
83 | | -| Command | Description | |
84 | | -|-------------------------|-------------------------------------------------------------------------------------------------------| |
85 | | -| `npm run web:serve` | Execute the app in the web browser (DEV mode) | |
86 | | -| `npm run web:prod` | Build the app that can be used directly in the web browser. Your built files are in the /dist folder. | |
87 | | -| `npm run tauri:bundle` | Builds your application and creates an app consumable based on your operating system | |
88 | | - |
89 | | -**Your application is optimised. Only /dist folder is included in the final bundle.** |
90 | | - |
91 | | -## Branch & Packages version |
92 | | - |
93 | | -[maintained-badge]: https://img.shields.io/badge/maintained-yes-brightgreen |
94 | | -[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg |
95 | | -[license]: https://github.com/maximegris/angular-tauri/blob/main/LICENSE.md |
96 | | -[prs-badge]: https://img.shields.io/badge/PRs-welcome-red.svg |
97 | | -[prs]: http://makeapullrequest.com |
98 | | - |
99 | | -[tauri-build-badge]: https://github.com/maximegris/angular-tauri/workflows/Tauri%20Build/badge.svg |
100 | | -[tauri-build]: https://github.com/maximegris/angular-tauri/actions?query=workflow%3A%22Tauri+Build%22 |
101 | | - |
102 | | -[github-watch-badge]: https://img.shields.io/github/watchers/maximegris/angular-tauri.svg?style=social |
103 | | -[github-watch]: https://github.com/maximegris/angular-tauri/watchers |
104 | | -[github-star-badge]: https://img.shields.io/github/stars/maximegris/angular-tauri.svg?style=social |
105 | | -[github-star]: https://github.com/maximegris/angular-tauri/stargazers |
106 | | -[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20angular-tauri!%20https://github.com/maximegris/angular-tauri%20%F0%9F%91%8D |
107 | | -[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/maximegris/angular-tauri.svg?style=social |
| 50 | +This project is licensed under the MIT License - see the LICENSE file for details. |
0 commit comments