first commit

CycloneAddons · Dec 24, 2024 · e5c0309 · e5c0309
commit e5c0309
Show file tree

Hide file tree

Showing 280 changed files with 9,909 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["tauri-apps.tauri-vscode", "rust-lang.rust-analyzer"]
+}
diff --git a/README.md b/README.md
@@ -0,0 +1,119 @@
+# 🛡️ Battery Protector
+<p align="center">
+  <img src="./src-tauri/icons/icon.png" alt="Battery Protector Logo" width="250" height="250">
+</p>
+
+Battery Protector is a lightweight software for Windows that alerts the user when the battery reaches 80% and plays music until the charger is unplugged. It also displays the battery percentage in the system tray.
+
+---
+
+## 🚀 Features
+
+- 🔔 **Battery Alert**: Notifies the user when the battery reaches 80%.(Soon Customizable)
+- 🎵 **Music Alert**: Plays music until the charger is unplugged.
+- 📌 **Tray Icon**: Displays the current battery percentage in the system tray.
+- ℹ️ **Battery Status Tooltip**: Shows detailed battery status in the tray icon tooltip.(Soon)
+- ⚙️ **Customizable Alerts**: Will allows users to customize alert sounds and notification settings.(Soon)
+
+---
+
+## 📥 Installation
+
+1. Clone the repository:
+   ```sh
+   git clone https://github.com/CycloneAddons/battery-protector.git
+   ```
+2. Navigate to the project directory:
+   ```sh
+   cd battery-protector
+   ```
+3. Install dependencies:
+   ```sh
+   npm install
+   ```
+4. Run the project:
+   ```sh
+   npm run tauri dev
+   ```
+   ### <p align="center">OR</p>
+
+    ```sh
+   npm run tauri build
+    ```
+
+---
+
+## 📖 Usage
+
+The application will start monitoring the battery status once launched:
+
+- ⚡ When the battery reaches **80%**, an alert sound will play, and the battery percentage will be displayed in the tray icon.
+- 🔌 The alert sound will continue until the charger is unplugged.
+
+### <p align="center">📷 Screenshot Demonstration</p>  
+<p align="center">
+  <img src="./screenshots/image.png" alt="Battery Protector Screenshot" width="500">
+</p>
+
+### <p align="center">📷 Video Demonstration</p>  
+<p align="center">Soon
+  <!-- <a>
+    <img src="" alt="Battery Protector Video Demonstration" width="500">
+  </a> -->
+</p>
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions to make **Battery Protector** better! To contribute:
+
+1. Fork the repository.
+2. Create a new branch:  
+   ```sh
+   git checkout -b feature-name
+   ```
+3. Commit your changes:  
+   ```sh
+   git commit -m "Add your message here"
+   ```
+4. Push the branch:  
+   ```sh
+   git push origin feature-name
+   ```
+5. Submit a pull request.
+
+---
+
+## 📜 License
+
+This project is licensed under the **MIT License**. See the [LICENSE](./LICENSE) file for details.
+
+---
+
+## 🛠 Maintenance
+
+This project is actively maintained. For bug reports or feature requests, please [open an issue](https://github.com/CycloneAddons/battery-protector/issues).
+
+---
+
+> **Note**: Currently, this project is intended for **Windows users only**.
+
+---
+### 👨‍💻 Developer & Owner
+
+**Developed and owned by Cyclone Addons**  
+[GitHub Profile](https://github.com/CycloneAddons)
+
+---
+
+### ❤️ Support
+
+If you find this project helpful, consider giving it a ⭐ on GitHub!
+
+<a href="https://www.buymeacoffee.com/cycloneaddons">
+  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"width="100"  alt="Buy Me A Coffee">
+</a>
+
+![GitHub Stars](https://img.shields.io/github/stars/CycloneAddons/battery-protector?style=social)  
+![GitHub Forks](https://img.shields.io/github/forks/CycloneAddons/battery-protector?style=social)
diff --git a/index.html b/index.html
@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Battery Protector</title>
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+<link href="https://fonts.googleapis.com/css2?family=Kranky&family=Merienda:[email protected]&family=Pixelify+Sans:[email protected]&family=Playwrite+US+Modern+Guides&display=swap" rel="stylesheet">
+</head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>