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

https://github.com/davidyen1124/fireworks

Launch dazzling fireworks at your fingertips
https://github.com/davidyen1124/fireworks

animation canvas fireworks interactive javascript react vite

Last synced: 3 months ago
JSON representation

Launch dazzling fireworks at your fingertips

Awesome Lists containing this project

README

          

# 🎆 Interactive Fireworks: Because Your Life Needs More Explosions

[![Made with React](https://img.shields.io/badge/Made%20with-React-61DAFB?style=for-the-badge&logo=react&logoColor=white)](https://reactjs.org/)
[![Powered by Canvas](https://img.shields.io/badge/Powered%20by-HTML5%20Canvas-E34F26?style=for-the-badge&logo=html5&logoColor=white)](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API)
[![Vite](https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white)](https://vitejs.dev/)
[![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-222222?style=for-the-badge&logo=github&logoColor=white)](https://pages.github.com/)
[![License: Sarcastic](https://img.shields.io/badge/License-Hilariously%20Sarcastic-ff69b4?style=for-the-badge)](./LICENSE)
[![Maintained]()](https://github.com/davidyen1124/fireworks)
[![Works on My Machine](https://img.shields.io/badge/Works%20on-My%20Machine-brightgreen?style=for-the-badge)](https://blog.codinghorror.com/the-works-on-my-machine-certification-program/)
[![Build Status](https://img.shields.io/badge/Build-Probably%20Works-yellow?style=for-the-badge)](https://github.com/davidyen1124/fireworks/actions)
[![Dependencies](https://img.shields.io/badge/Dependencies-Too%20Many-red?style=for-the-badge)](package.json)
[![Code Quality](https://img.shields.io/badge/Code%20Quality-Questionable-orange?style=for-the-badge)](https://github.com/davidyen1124/fireworks)
[![Commits](https://img.shields.io/badge/Commits-Chaotic-purple?style=for-the-badge)](https://github.com/davidyen1124/fireworks/commits)
[![Fun Factor](https://img.shields.io/badge/Fun%20Factor-Over%209000-ff6b6b?style=for-the-badge)](https://www.youtube.com/watch?v=SiMHTK15Pik)
[![Explosion Level](https://img.shields.io/badge/Explosion%20Level-Michael%20Bay-FF4500?style=for-the-badge)](https://en.wikipedia.org/wiki/Michael_Bay)
[![Batteries Included](https://img.shields.io/badge/Batteries-Not%20Included-lightgrey?style=for-the-badge)](https://xkcd.com/1739/)
[![Coffee Powered](https://img.shields.io/badge/Powered%20by-Coffee%20%26%20Tears-6F4E37?style=for-the-badge&logo=coffee)](https://www.buymeacoffee.com/definitely-not-a-real-link)
[![Bugs](https://img.shields.io/badge/Bugs-Features%20in%20Disguise-brightgreen?style=for-the-badge)](https://github.com/davidyen1124/fireworks/issues)
[![Support](https://img.shields.io/badge/Support-Stack%20Overflow-f48024?style=for-the-badge&logo=stackoverflow)](https://stackoverflow.com/)
[![Documentation](https://img.shields.io/badge/Documentation-What%20Documentation%3F-red?style=for-the-badge)](https://github.com/davidyen1124/fireworks/blob/main/README.md)
[![Tested](https://img.shields.io/badge/Tested-In%20Production-red?style=for-the-badge)](https://github.com/davidyen1124/fireworks)
[![Security](https://img.shields.io/badge/Security-Through%20Obscurity-yellow?style=for-the-badge)](https://en.wikipedia.org/wiki/Security_through_obscurity)

_Finally, a way to blow stuff up without the FBI showing up at your door!_

🎮 [Live Demo](https://davidyen1124.github.io/fireworks/) _(Warning: May cause uncontrollable clicking)_

![Interactive Fireworks Preview](media/preview.gif)

_Look at those beautiful pixels exploding in perfect harmony! Just like my code review feedback._

## 🎆 Features (AKA: What You're Getting Into)

- **Real-time fireworks animation**: Because static images are for quitters
- **Interactive click/touch controls**: Your mouse has never felt so powerful
- **Twinkling star background**: Stars that twinkle more than your career prospects
- **Smooth rocket trails**: Smoother than your pickup lines
- **Responsive design**: Works on devices from potato phones to NASA supercomputers
- **Beautiful color variations**: More colors than a unicorn's breakfast

## 🚀 Getting Started (If You Dare)

_"Another JavaScript project? How original!" - Every developer ever_

1. Clone this masterpiece (and by masterpiece, I mean organized chaos):

```bash
git clone https://github.com/davidyen1124/fireworks.git
cd fireworks
```

2. Install dependencies (prepare for npm install hell):

```bash
npm install
# Go grab a coffee, write a novel, learn a new language...
```

3. Start the development server (cross your fingers):

```bash
npm run dev
# If it doesn't work, try turning it off and on again
```

## 💫 How to Use (It's Not Rocket Science... Wait, Actually It Is)

- **Click or touch anywhere**: Watch the magic happen (or watch it crash spectacularly)
- **Hold down**: Create continuous fireworks (because one explosion is never enough)
- **Move while holding**: Create trails (like breadcrumbs, but more explosive)

_Pro tip: If nothing happens, you probably broke it. Congratulations!_

## 🛠️ Built With (The Usual Suspects)

- **React**: Because vanilla JS is apparently too mainstream
- **HTML Canvas**: The last bastion of drawing on the web
- **JavaScript**: The language that keeps on giving (bugs)
- **Vite**: Because Webpack wasn't complicated enough

## 📦 Deployment (The "It Works on My Machine" Experience)

This project magically deploys itself to GitHub Pages using GitHub Actions. It's like having a personal assistant, except it never complains and works for free.

🌐 **Live at**: https://davidyen1124.github.io/fireworks/

_If the site is down, it's not my fault. Blame the internet, climate change, or your ISP._

## 🎨 Preview (Spoiler Alert: It's Shiny)

Experience the earth-shattering revelation of clicking on a screen and watching colorful particles move around! Revolutionary stuff, really. Perfect for:

- Procrastinating on actual work
- Impressing your cat
- Demonstrating to your parents that you "do computers"
- Filling the void in your soul with artificial explosions

---

_Disclaimer: No actual fireworks were harmed in the making of this project. Your productivity, however, is another story._

**Made with ❤️ and an unhealthy amount of caffeine**