Open Kahoot

An open source kahoot clone

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

Open Kahoot aims to be an open source, self-hostable kahoot-like trivia system.

It consists of two parts, the server and the client.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• PostgreSQL
• Rust
• npm
• Node.js

Installation

Installation instructions can be found in the client and server directories, respectively.

(back to top)

Roadmap

• Server
  • Put login sessions and game rooms in redis
  • Email support
    • Confirmation emails
    • Password change request
  • Refactoring
    • Refactor out socket events to own files in server
• Client
  • UI Redesign
    • Player view
    • Host view
    • Quiz editor

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)