Skip to content

Latest commit

 

History

History
90 lines (64 loc) · 3.48 KB

README.md

File metadata and controls

90 lines (64 loc) · 3.48 KB
Raw

CrosswordGPT

CrosswordGPT instantly turns any topic you love into fun crossword puzzles. Unlike regular crosswords that come ready-made, this app creates endless puzzles just for you, matching your interests and how hard you want them to be. It's like having a personal puzzle maker that knows exactly what you enjoy.

Built with Next.js and AI technology, this open-source template helps developers create their own puzzle apps. As more people look for smart ways to learn while having fun, this template lets you build your own crossword app quickly and easily.

Live Demo

https://crossword-gpt.vercel.app/

Features

  • AI-powered puzzle generation
  • Multiple knowledge domains (Science, History, Literature, etc.)
  • Interactive grid interface with keyboard navigation
  • Real-time answer validation

Technologies Used

  • Next.js and React for Frontend and Backend
  • Tailwind CSS for Styling
  • OpenAI API for AI-Powered Features

Use Cases

  • Generate custom crosswords for any domain and test domain-specific knowledge.
  • Practice technical concepts and professional jargon through AI-generated puzzles with adjustable difficulty levels.
  • Utilize crossword puzzles for vocabulary building, exam preparation, or specialized field training.

Installation Steps

1. Clone the repository:

git clone https://github.com/0xmetaschool/ai-crossword-generator
cd ai-crossword-generator

2. Install dependencies:

npm install

3. Set up environment variables: Create a .env.local file in the root directory and add:

OPENAI_API_KEY=your_openai_api_key

4. Run the development server:

npm run dev

5. Open your browser and navigate to http://localhost:3000

Screenshots

CrosswordGPT Template Landing Page screenshot CrosswordGPT Template Home Page screenshot
CrosswordGPT Template Puzzle Page screenshot

How to use the application

  1. Click on the "Play Crossword Puzzle" button on the Landing page
  2. Select a field of interest (Science, History, etc.) and the difficulty
  3. Click "Generate Crossword" to create a unique puzzle
  4. Fill your answers and use "Check Answers" to validate your progress
  5. View your score and completed words
  6. Use "Show Answers" if you need help

Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

Please open an issue in the GitHub repository for any queries or support.