{"id":35129209,"url":"https://github.com/deadronos/voxel-celebration","last_synced_at":"2026-03-18T02:23:58.538Z","repository":{"id":330862884,"uuid":"1123763429","full_name":"deadronos/voxel-celebration","owner":"deadronos","description":"The demo showcases a cozy voxel village, dynamic fireworks, floating sky lanterns, and particle/post-processing effects — designed to be easy to extend and perform well in real time.","archived":false,"fork":false,"pushed_at":"2026-02-14T18:01:16.000Z","size":1449,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-15T01:45:36.767Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://deadronos.github.io/voxel-celebration/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deadronos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-12-27T15:13:23.000Z","updated_at":"2026-02-14T17:58:47.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/deadronos/voxel-celebration","commit_stats":null,"previous_names":["deadronos/voxel-celebration"],"tags_count":10,"template":false,"template_full_name":"google-gemini/aistudio-repository-template","purl":"pkg:github/deadronos/voxel-celebration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deadronos%2Fvoxel-celebration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deadronos%2Fvoxel-celebration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deadronos%2Fvoxel-celebration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deadronos%2Fvoxel-celebration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deadronos","download_url":"https://codeload.github.com/deadronos/voxel-celebration/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deadronos%2Fvoxel-celebration/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30642934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-18T01:41:58.583Z","status":"online","status_checked_at":"2026-03-18T02:00:07.824Z","response_time":104,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-28T04:32:11.942Z","updated_at":"2026-03-18T02:23:58.503Z","avatar_url":"https://github.com/deadronos.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Voxel Celebration 🎆\n\n**Voxel Celebration** is an interactive 3D voxel-style New Year's celebration demo built with **React**, **TypeScript**, and **Three.js** (via React Three Fiber).\n\nThe demo showcases a cozy voxel village, dynamic fireworks, floating sky lanterns, and particle/post-processing effects — designed to be easy to extend and perform well in real time.\n\n![Voxel Celebration Screenshot](./image.png)\n\n---\n\n## Highlights ✅\n\n- Configurable fireworks system (rockets, bursts, colors, timing)\n- Sky lanterns that float and glow\n- Voxel houses and environment components\n- Particle systems and post-processing for cinematic visuals\n- Performance-minded (instancing, memoization, efficient updates)\n\n---\n\n## Tech stack 🔧\n\n- React + TypeScript\n- Three.js + React Three Fiber (@react-three/fiber)\n- @react-three/drei and postprocessing helpers\n- Vite for dev server and build\n- Vitest for unit tests\n- ESLint + Prettier for code style\n\n---\n\n## Quick start ⚡\n\n**Prerequisites:** Node.js (18+ recommended)\n\n1. Install dependencies\n\n```bash\nnpm install\n```\n\n1. Run the dev server\n\n```bash\nnpm run dev\n# then open http://localhost:5173\n```\n\n1. Build \u0026 preview\n\n```bash\nnpm run build\nnpm run preview\n```\n\n1. Tests / lint / typecheck / format\n\n```bash\nnpm test\nnpm run lint\nnpm run typecheck\nnpm run format\n```\n\n---\n\n## Project layout 📁\n\n- `src/` — application source\n  - `App.tsx`, `main.tsx` — entry\n  - `components/` — scene components (e.g., `FireworksManager.tsx`, `SkyLantern.tsx`, `Environment.tsx`, `House.tsx`, `VoxelUtils.tsx`)\n  - `utils/` — fireworks \u0026 rocket logic (`fireworks.ts`, `rocket.ts`)\n- `tests/vitest/` — unit tests (`fireworks.test.ts`, `rocket.test.ts`)\n- `memory/` — project memory bank (requirements, designs, tasks, progress)\n\n---\n\n## Development notes 💡\n\n- To change fireworks behaviour, edit `src/utils/fireworks.ts` and `src/components/FireworksManager.tsx`.\n- Keep visual changes performant: prefer instancing for repeated geometry and minimize per-frame allocations.\n- Add tests for deterministic logic in `tests/vitest/` when modifying particle/rocket behaviour.\n\n---\n\n## Deployment 🚀\n\n- This repository includes a GitHub Actions workflow at `.github/workflows/deploy-pages.yml` that builds the site via `npm run build`, uploads the generated `dist/` artifact with `actions/upload-pages-artifact@v3`, and deploys it using `actions/deploy-pages@v4`.\n- The workflow **runs when a tag matching `v*`** (for example `v1.0.0`) is pushed to the repository — a tag push will trigger a build and deployment.\n- Make sure your repository Pages settings allow deployments from GitHub Actions (the action will create a Pages deployment). If you prefer, you can protect the `github-pages` environment in repository settings.\n- After a successful deployment the site should be available at: `https://deadronos.github.io/voxel-celebration/` (production builds use the repo-path base).\n- The `vite` config is set so production builds will use the base `'/voxel-celebration/'` (the dev server still uses `/`).\n\n---\n\n## Contributing 🤝\n\n1. Open an issue describing the feature or bug.\n2. Create a PR with a clear description and add tests for logic changes.\n3. Ensure `npm test`, `npm run lint`, and `npm run typecheck` pass locally before requesting review.\n\n\u003e Note: A minimal GitHub Actions CI workflow (`.github/workflows/ci.yml`) runs on pull requests and pushes to `main` to validate `lint`, `format:check`, `typecheck`, and `test` automatically.\n\n1. Update `memory/` with designs or task notes for non-trivial changes.\n\n---\n\n## License \u0026 credits\n\nSee `LICENSE` (if present) for license details. The project is inspired by voxel art and fireworks simulations.\n\n---\n\nIf you'd like, I can also add an example screenshot or short demo GIF to the README — tell me what you'd prefer to show! 🎇\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeadronos%2Fvoxel-celebration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeadronos%2Fvoxel-celebration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeadronos%2Fvoxel-celebration/lists"}