/crystal-skull

💀 Containerized HTTP API which generates a complete quiz using just a topic name or supplied text

Primary LanguageKotlinMIT LicenseMIT

Crystal Skull

Crystal Skull

For developers who want to build an innovative quiz app, Crystal Skull is a server that generates complete quizzes using just a topic name or supplied text. Unlike other quiz generators, our product is unique and easy to use.

The name Crystal Skull comes from the movie Indiana Jones and the Kingdom of the Crystal Skull. The movie shows an alien with a crystal skull who seems to have knowledge on everything. This program, too, seems to have knowledge on everything 😉.

Installation

  1. Install Docker.
  2. Clone the repository using one of the following methods.
    • SSH: git clone git@github.com:neelkamath/crystal-skull.git
    • HTTPS: git clone https://github.com/neelkamath/crystal-skull.git
  3. Optionally, generate a wrapper for the HTTP API using OpenAPI Generator on the file https://raw.githubusercontent.com/neelkamath/crystal-skull/master/docs/openapi.yaml.

Usage

docker-compose --project-directory . -f docker/docker-compose.yml -f docker/docker-compose.prod.yml up --build

The server will be running on http://localhost:80.

Contributing

Credits

Built with spaCy

The quiz generator uses text from Wikipedia which is licensed under CC-BY-SA.

Although he didn't convey how or what to do in any way, Sundararaman showed me the idea of generating fill-in-the-blank questions using Wikipedia.

The wait-for-it.sh script was taken from vishnubob.

License

This project is under the MIT License.