Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 1.51 KB

README.md

File metadata and controls

62 lines (36 loc) · 1.51 KB
Raw

Open source Kahoot alternative

This is an open source Kahoot alternative , a game-based learning platform that brings engagement and fun at school, work, and at home. This project aims to provide similar functionality to Kahoot while being customizable and extensible for various educational and entertainment purposes.

  1. The host starts the game
  2. Players join the game
  3. The host starts the questions
  4. Players answer the questions
  5. Results are shown

Built With

Run Locally

# Install dependencies 

npm install

# Start Supabase

supabase start

# Start Next.js locally

npm run dev

# Access app in your web browser at `http://localhost:3000`.

Access the project root at / to join as a player.

Access /host to join as a host.

Generate Types

supabase gen types typescript --local --schema public > src/types/supabase.ts

read more on generating types

Contributing

We welcome contributions from the community! If you'd like to contribute, please follow these guidelines:

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

License

This project is licensed under the MIT License