{"id":23859065,"url":"https://github.com/hamburgj/react-game-base","last_synced_at":"2025-07-20T02:31:48.475Z","repository":{"id":269462485,"uuid":"907482597","full_name":"HamburgJ/react-game-base","owner":"HamburgJ","description":"A feature-rich template for building daily puzzle games like Wordle, Connections, and more. Includes automatic deployment, state persistence, daily streak tracking, and a clean, responsive design. Perfect for developers looking to create engaging browser-based games with minimal setup.","archived":false,"fork":false,"pushed_at":"2025-01-02T17:53:10.000Z","size":68,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-19T05:49:29.148Z","etag":null,"topics":["bootstrap","connections","daily-games","game-template","github-pages","open-source","react","reactjs","responsive-design","template","template-project","typescript","web-development","web-template","worlde"],"latest_commit_sha":null,"homepage":"","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/HamburgJ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2024-12-23T17:21:34.000Z","updated_at":"2025-01-02T17:53:13.000Z","dependencies_parsed_at":"2025-06-19T05:40:29.514Z","dependency_job_id":"b18d8553-afbf-4f3b-92ba-f1e7773573f6","html_url":"https://github.com/HamburgJ/react-game-base","commit_stats":null,"previous_names":["hamburgj/react-game-base"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/HamburgJ/react-game-base","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HamburgJ%2Freact-game-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HamburgJ%2Freact-game-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HamburgJ%2Freact-game-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HamburgJ%2Freact-game-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HamburgJ","download_url":"https://codeload.github.com/HamburgJ/react-game-base/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HamburgJ%2Freact-game-base/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266058467,"owners_count":23870155,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["bootstrap","connections","daily-games","game-template","github-pages","open-source","react","reactjs","responsive-design","template","template-project","typescript","web-development","web-template","worlde"],"created_at":"2025-01-03T03:30:09.298Z","updated_at":"2025-07-20T02:31:48.453Z","avatar_url":"https://github.com/HamburgJ.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# React Game Base Template\n\nA template repository for creating daily browser games like Wordle, Connections, or similar puzzle games. Features automatic deployment, state persistence, daily streaks, and responsive design.\n\n## Play the [Live Demo](https://burgerfun.tech/four-nines/) of Four Nines, a daily puzzle game created from this template\n\n## Features\n\n- 🎮 Perfect for daily puzzle games\n- 🌙 Built-in dark/light theme\n- 📊 Daily streak tracking\n- 🔄 Automatic state persistence\n- 📱 Mobile-first responsive design\n- 🚀 One-click GitHub Pages deployment\n- 📈 Google Analytics 4 support\n- 🎨 Clean, modern UI with Bootstrap\n- 🔗 Social sharing with result grids\n- 📊 Stats comparison system\n\n## Quick Start\n\n1. Click \"Use this template\" to create your repository\n2. Enable GitHub Pages:\n   - Go to repository Settings \u003e Pages\n   - Under \"Build and deployment\", select \"GitHub Actions\" as the source\n3. Configure analytics and sharing:\n   - Copy `.env.example` to `.env`\n   - Add your Google Analytics 4 ID\n   - Add your game preview image at `/public/game-preview.png`\n4. Your game will be live at `https://yourusername.github.io/your-repo-name`\n\n## Customization\n\nLook for `TODO` comments in these files:\n\n### Required Changes\n1. `src/pages/Play.tsx`\n   - Replace placeholder with your game logic\n   - Customize completion state display\n\n2. `src/pages/Home.tsx`\n   - Update game title and introduction\n   - Customize welcome message\n\n3. `src/types/GameState.ts`\n   - Add game-specific state properties\n   - Add game-specific settings\n\n### Optional Changes\n1. `public/game-icon.svg`\n   - Replace with your game icon\n\n2. `src/styles/global.css`\n   - Customize colors and theme\n   - Add game-specific styles\n\n3. `src/components/InfoModal.tsx`\n   - Update game instructions\n   - Add game features list\n\n## Built-in Features\n\n### State Management\n```typescript\nconst { gameState, updateGameState } = useGameState();\n\n// Update game state\nupdateGameState({\n  score: newScore,\n  todayCompleted: true,\n});\n```\n\n### Daily Puzzles\n- Automatically generates puzzle number from date\n- Tracks completion status\n- Prevents replaying completed puzzles\n- Shows stats after completion\n\n### Theme Support\n```typescript\nconst { theme, toggleTheme } = useTheme();\n```\n\n### Result Sharing\n```typescript\n// Share results with native share API or clipboard fallback\nconst shareText = generateShareText({\n  title: 'My Game',\n  dayNumber: puzzleNumber,\n  streak: 5,\n  stats: gameStats\n});\nawait shareResults(shareText);\n```\n\n### Stats Tracking\n- Games played\n- Win rate\n- Current streak\n- Best streak\n- Daily completion status\n\n### Analytics Integration\n1. Set up Google Analytics:\n   ```env\n   # .env\n   VITE_GA_ID=G-XXXXXXXXXX\n   ```\n\n2. Track custom events:\n   ```typescript\n   gtag('event', 'puzzle_complete', {\n     puzzle_number: puzzleNumber,\n     streak: streak\n   });\n   ```\n\n### Social Media Integration\n- Open Graph meta tags for rich previews\n- Twitter card support\n- Customizable share images\n- Automatic puzzle numbering\n\n## Game Development Tips\n\n### State Persistence\nAll game state is automatically saved to localStorage. Common state properties:\n- `todayCompleted`: Whether today's puzzle is completed\n- `streak`: Daily visit streak\n- `lastPlayed`: Last played timestamp\n- `gamesPlayed`: Total games completed\n- `winRate`: Player's win rate\n\n### Adding Custom Features\n\n1. **Daily Puzzles**\n```typescript\nconst getTodaysPuzzle = () =\u003e {\n  const today = new Date();\n  const puzzleIndex = Math.floor(today.getTime() / (24 * 60 * 60 * 1000));\n  return puzzles[puzzleIndex % puzzles.length];\n};\n```\n\n2. **Progress Saving**\n```typescript\nupdateGameState({\n  todayCompleted: true,\n  gamesPlayed: gamesPlayed + 1,\n  winRate: calculateWinRate(),\n});\n```\n\n3. **Statistics**\n```typescript\nupdateGameState({\n  gamesPlayed: gameState.gamesPlayed + 1,\n  winRate: (gamesPlayed - 1) / gamesPlayed,\n  maxStreak: Math.max(maxStreak, streak),\n});\n```\n\n### Common Game Patterns\n\n1. **Daily Reset**\n```typescript\nconst isNewDay = () =\u003e {\n  const lastPlayed = new Date(gameState.lastPlayed);\n  const now = new Date();\n  return !isSameDay(lastPlayed, now);\n};\n```\n\n2. **Share Results**\n```typescript\nconst handleShare = async () =\u003e {\n  const text = generateShareText({\n    title: 'Game Title',\n    dayNumber: puzzleNumber,\n    streak,\n    stats: gameStats\n  });\n  await shareResults(text);\n};\n```\n\n## Common Issues\n\n1. **GitHub Pages 404**: Make sure GitHub Pages is enabled and set to deploy from GitHub Actions\n2. **State Reset**: The reset functionality clears ALL game progress\n3. **Mobile Testing**: Test touch interactions thoroughly\n4. **Analytics Not Working**: Verify your GA4 ID in `.env` file\n5. **Share Not Working**: Some browsers restrict clipboard access to HTTPS\n\n## License\n\nMIT License - feel free to use this template for any purpose.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhamburgj%2Freact-game-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhamburgj%2Freact-game-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhamburgj%2Freact-game-base/lists"}