https://github.com/ellipog/gruble
https://github.com/ellipog/gruble
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ellipog/gruble
- Owner: Ellipog
- Created: 2024-12-22T22:51:42.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-04T15:12:21.000Z (over 1 year ago)
- Last Synced: 2025-02-04T16:22:24.786Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://gruble-zeta.vercel.app
- Size: 166 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🎲 Gruble
A modern web application for generating and playing word category games. Built with Next.js and TypeScript.
## ✨ Features
- 📝 Generate word category games with custom categories
- 🎯 Random letter generation
- 🎨 Beautiful, responsive UI built with Tailwind CSS
- 📱 Mobile-friendly design
- 📄 PDF export functionality
- 🎮 Interactive game grid
- 🔄 Category shuffling and customization
## 🚀 Getting Started
### Prerequisites
- Node.js (v18 or higher)
- npm or yarn
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/gruble.git
cd gruble
```
2. Install dependencies:
```bash
bun install
```
3. Run the development server:
```bash
bun dev
```
4. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application.
## 🛠️ Built With
- [Next.js](https://nextjs.org/) - React framework
- [TypeScript](https://www.typescriptlang.org/) - Type safety
- [Tailwind CSS](https://tailwindcss.com/) - Styling
- [Framer Motion](https://www.framer.com/motion/) - Animations
- [html2pdf.js](https://www.npmjs.com/package/html2pdf.js) - PDF generation
## 📝 Usage
1. Select your desired word categories
2. Generate random letters
3. Fill in words that match both the categories and start with the given letters
4. Export to PDF if needed
5. Create custom categories for more variety
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
---
by Elliot