Freepardy

A free, customizable Jeopardy-style quiz game built with Next.js and Tailwind CSS.

Features

• Create and edit categories and questions
• Import/export game data as JSON
• Final Jeopardy round with wagering
• Team scoring system
• Timer functionality
• Mobile-responsive design
• Offline support with PWA capabilities
• Share game configurations via URL
• Multilingual rules (English and German)
• Accessible UI components (Radix UI)

Getting Started

Prerequisites

• Node.js 18 or later
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/PalmaAnd/freepardy.git
   cd freepardy

2. Install dependencies and run the development server:

   npm install
   npm run dev

   or

   yarn install
   yarn dev

3. Open http://localhost:3000 in your browser.

Deployment

This project is configured for automatic deployment to GitHub Pages using GitHub Actions.

1. Push your code to the main branch of your GitHub repository.
2. GitHub Actions will automatically build and deploy your site.
3. Your site will be available at https://yourusername.github.io/freepardy.

Customization

Game Data

You can customize the game by:

• Using the Admin Panel to create categories and questions
• Importing a JSON file with your game data
• Sharing a game configuration via URL

Styling

The game uses Tailwind CSS for styling. You can customize the appearance by modifying the Tailwind configuration in tailwind.config.ts.

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md for guidelines.

Code of Conduct

Please review our CODE_OF_CONDUCT.md to help us keep this project open and welcoming.

Security

If you discover a security vulnerability, please see SECURITY.md for responsible disclosure guidelines.

Acknowledgments

• Inspired by the Jeopardy! TV game show
• Built with Next.js, Tailwind CSS, and Radix UI

Useful Open Source Files

• CONTRIBUTING.md: Guidelines for contributing to this project.
• CODE_OF_CONDUCT.md: Code of conduct for participants.
• LICENSE: Project license.