|
1 | | -# Tauri + React + Typescript |
| 1 | +# Nginx WAF Desktop Client |
2 | 2 |
|
3 | | -This template should help get you started developing with Tauri, React and Typescript in Vite. |
| 3 | +A desktop application for managing Nginx Web Application Firewall (WAF) configurations. Built with Tauri (Rust backend) and React (frontend), providing a user-friendly interface for monitoring, configuring, and maintaining WAF settings. |
4 | 4 |
|
5 | | -## Recommended IDE Setup |
| 5 | +## Features |
6 | 6 |
|
7 | | -- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) |
| 7 | +- **Dashboard**: Overview of system status, alerts, and performance metrics. |
| 8 | +- **Domain Management**: Add, edit, and remove protected domains. |
| 9 | +- **ModSecurity Rules**: Custom rule creation and management for security policies. |
| 10 | +- **Network Load Balancer**: Configure and monitor load balancing settings. |
| 11 | +- **Logs**: View and analyze access and error logs. |
| 12 | +- **SSL/TLS Management**: Handle certificates and SSL configurations. |
| 13 | +- **User Management**: Account settings, authentication, and permissions. |
| 14 | +- **Backup & Restore**: Data backup and recovery functionalities. |
| 15 | + |
| 16 | +## Prerequisites |
| 17 | + |
| 18 | +- **Node.js** (v16 or later) |
| 19 | +- **Rust** (latest stable version) |
| 20 | +- **Tauri CLI**: Install with `npm install -g @tauri-apps/cli` |
| 21 | + |
| 22 | +## Installation & Build |
| 23 | + |
| 24 | +1. Clone the repository: |
| 25 | + ```bash |
| 26 | + git clone https://github.com/TinyActive/nginx-waf-apps-client.git |
| 27 | + cd nginx-waf-apps-client |
| 28 | + ``` |
| 29 | + |
| 30 | +2. Install frontend dependencies: |
| 31 | + ```bash |
| 32 | + npm install |
| 33 | + ``` |
| 34 | + |
| 35 | +3. Build the application: |
| 36 | + ```bash |
| 37 | + npm run tauri build |
| 38 | + ``` |
| 39 | + |
| 40 | +The built application will be available in `src-tauri/target/release/bundle/`. |
| 41 | + |
| 42 | +## Development |
| 43 | + |
| 44 | +To run in development mode: |
| 45 | +```bash |
| 46 | +npm run tauri dev |
| 47 | +``` |
| 48 | + |
| 49 | +This starts the frontend dev server and Tauri application. |
| 50 | + |
| 51 | +## Usage |
| 52 | + |
| 53 | +After building, run the executable from the bundle directory. The app provides a GUI for all WAF management tasks. Ensure your Nginx WAF server is running and accessible. |
| 54 | + |
| 55 | +## Contributing |
| 56 | + |
| 57 | +We welcome contributions! Please follow these steps: |
| 58 | + |
| 59 | +1. Fork the repository. |
| 60 | +2. Create a feature branch: `git checkout -b feature/your-feature-name` |
| 61 | +3. Make your changes and commit: `git commit -m 'Add some feature'` |
| 62 | +4. Push to the branch: `git push origin feature/your-feature-name` |
| 63 | +5. Open a Pull Request. |
| 64 | + |
| 65 | +### Guidelines |
| 66 | +- Follow the existing code style. |
| 67 | +- Add tests for new features. |
| 68 | +- Update documentation as needed. |
| 69 | +- Ensure builds pass on all platforms. |
| 70 | + |
| 71 | +## License |
| 72 | + |
| 73 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
0 commit comments