Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arnavk-09/countdown_terminal
⏰ A terminal countdown timer app in Rust...
https://github.com/arnavk-09/countdown_terminal
bash cli countdown crossplatform npm npx ratatui rust terminal tui
Last synced: about 1 month ago
JSON representation
⏰ A terminal countdown timer app in Rust...
- Host: GitHub
- URL: https://github.com/arnavk-09/countdown_terminal
- Owner: ArnavK-09
- Created: 2024-11-17T12:50:02.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T14:59:08.000Z (about 1 month ago)
- Last Synced: 2024-11-22T15:36:27.117Z (about 1 month ago)
- Topics: bash, cli, countdown, crossplatform, npm, npx, ratatui, rust, terminal, tui
- Language: Rust
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
⏰ countdown_terminal ⏰
> [!NOTE]
>
> **countdown_terminal** is a terminal-based countdown timer app built with Rust, featuring real-time progress visualization and customizable countdown times.
## 🌟 Features
> **countdown_terminal** features:
- **Customizable Countdown Time** – Set the countdown in hours, minutes, or seconds.
- **Progress Visualization** – Visualize progress in a terminal-friendly gauge.
- **Terminal UI** – Built with Ratatui, offering a modern terminal UI experience.
## 🛠 Installation
> You can add **countdown_terminal** with one command via:
###### terminal
```bash
# Command for Installation
npx countdown_terminal
```
---
## 🐍 Cloning and Building Locally
> To clone and build the project locally, follow these steps:
1. **Clone the repository:**
###### terminal
```bash
git clone https://github.com/ArnavK-09/countdown_terminal.git
cd countdown-app
```
2. **Build the application:**
###### terminal
```bash
cargo build
```
3. **Run the application:**
###### terminal
```bash
cargo run
```
## 💻 Contributing
> [!TIP]
> We welcome contributions to improve **countdown_terminal**! If you have suggestions, bug fixes, or new feature ideas, follow these steps:
1. **Fork the Repository**
Click the **Fork** button at the top-right of the repo page.
2. **Clone Your Fork**
Clone the repo locally:
```bash
git clone https://github.com/ArnavK-09/countdown_terminal.git
```
3. **Create a Branch**
Create a new branch for your changes:
```bash
git checkout -b your-feature-branch
```
4. **Make Changes**
Implement your changes (bug fixes, features, etc.).
5. **Commit and Push**
Commit your changes and push the branch:
```bash
git commit -m "Description of changes"
git push origin your-feature-branch
```
6. **Open a Pull Request**
Open a PR with a detailed description of your changes.
7. **Collaborate and Merge**
The maintainers will review your PR, request changes if needed, and merge it once approved.
## 🙋♂️ Issues
Found a bug or need help? Please create an issue on the [GitHub repository](https://github.com/ArnavK-09/countdown_terminal/issues) with a detailed description.
## 👤 Author
---
📄 License
countdown_terminal is licensed under the Unlicense License. See the LICENSE file for more details.
---
💖 Thanks for Using countdown_terminal!
If you find this project helpful, please give it a ⭐ on GitHub!
