An open API service indexing awesome lists of open source software.

https://github.com/datwalkerv/streaker

Streaker is a sleek and modern web application designed to help you track your daily progress towards a goal.
https://github.com/datwalkerv/streaker

Last synced: 5 months ago
JSON representation

Streaker is a sleek and modern web application designed to help you track your daily progress towards a goal.

Awesome Lists containing this project

README

          

# Streaker

Streaker is a sleek and modern web application designed to help you track your daily progress towards a goal. With a clean, dark-themed interface, Streaker allows you to set an end goal, update your daily progress, visualize your progress with a graph, and even set a custom background image for motivation. It’s perfect for anyone looking to stay consistent and motivated!

![Streaker Screenshot](https://github.com/datwalkerv/Streaker/blob/main/streaker.webp)

---

## Features

- **Progress Tracking**: Log your daily progress and visualize it with a beautiful line graph.
- **End Goal Setting**: Set a target goal and track your progress towards it.
- **Progress Bar**: See how close you are to achieving your goal with a dynamic progress bar.
- **Custom Background**: Upload a custom background image to personalize your experience.
- **Toaster Notifications**: Get instant feedback with stylish notifications.
- **Social Links**: Connect with me via GitHub, Instagram, or email directly from the app.
- **Responsive Design**: Works seamlessly on both desktop and mobile devices.

---

## How to Use

1. **Set Your End Goal**:
- Click the goal icon (📊) in the top section.
- Enter your target goal in the modal and click "Submit".

2. **Update Your Progress**:
- Enter your daily progress in the input field.
- Click "Update Progress" to log your progress.

3. **Set a Background Image**:
- Click the image icon (🖼️) in the top section.
- Paste an image URL in the modal and click "Submit".

4. **Track Your Progress**:
- View your progress on the graph and progress bar.
- Celebrate your achievements as you get closer to your goal!

---

## Technologies Used

- **Frontend**:
- HTML, CSS (Tailwind CSS), JavaScript
- [Chart.js](https://www.chartjs.org/) for the progress graph
- [GSAP](https://greensock.com/gsap/) for animations
- [Toastify](https://apvarun.github.io/toastify-js/) for notifications

- **Hosting**:
- GitHub Pages

---

## Installation

To run this project locally, follow these steps:

1. **Clone the Repository**:
```bash
git clone https://github.com/datwalkerv/streaker.git
cd streaker
```
2. **Open the Project**:
- Open the `index.html` file in your browser.

3. **Host on GitHub Pages**:
- Push the project to a GitHub repository.
- Go to the repository settings, enable GitHub Pages, and select the `main` branch.

---

## Contributing

Contributions are welcome! If you’d like to contribute to Streaker, follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name`).
3. Commit your changes (`git commit -m 'Add some feature'`).
4. Push to the branch (`git push origin feature/your-feature-name`).
5. Open a pull request.

---

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

## Connect with Me

- **GitHub**: [datwalkerv](https://github.com/datwalkerv)
- **Instagram**: [balagbalint](https://instagram.com/balagbalint)
- **Email**: [bbalint139](mailto:bbalint139@gmail.com)

---

## Acknowledgments

- Thanks to [Tailwind CSS](https://tailwindcss.com/) for the amazing utility-first CSS framework.
- Special thanks to [Chart.js](https://www.chartjs.org/) for the interactive charts.
- Inspired by the need for a simple and elegant progress tracker.

---

Made with ❤️ by **datwalkerv**
© 2025 Streaker. All rights reserved.