Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.51 KB

README.md

File metadata and controls

51 lines (34 loc) · 1.51 KB
Raw

Logo

A new quiz website built to help people create, share and play quizzes.

With kwzz, quizzes can be made quickly and easily and shared so that anyone play them and test their knowledge. Once a user has played a quiz, they can easily review their results and receive feedback on the topics they did poorly on. Creators of quizzes can also review attempts to their quizzes to see how others do at them.

Screenshots

Setup

Make sure you have Node.js and Yarn installed.

$ git clone https://github.com/jonathanjameswatson/kwzz.git # or clone your own fork
$ cd kwzz
$ yarn install

Usage

# To run in development at localhost:3000
$ yarn run dev

# To run in production at localhost:3000
$ yarn run build
$ yarn run deploy

Database setup

Before starting the server, connect to the database and execute the contents of the schema.sql file found in the api/db directory.

Environment variables

  • JWT_SECRET - A secret key that should be set before deploying the website in production.
  • DATABASE_URL - PostgreSQL database connection string
  • DATABASE_SSL - Boolean describing whether or not SSL is required to access the database.

Website

Visit the website here

License

MIT