Quizzr

An open source, fun quizzing/revision platform for putting the fun into learning.

This is a passion project from me and Shmolph so development will be slow. But then we also have a lot of free time.

Instructions of how to run both parts

Frontend

The frontend runs on svelte with tailwind css, shadcn and some other packages.

How to run

You will need the following

• Latest version of nodejs
• Latest version of pnpm

Clone the repo

git clone https://github.com/bluekiwidev/Quizzr.git

Then cd into the repo's frontend

cd Quizzr/frontend

Install the deps with pnpm

pnpm install

Make your .env file

cp .env.example .env

Important

Remember to fill out the dummy .env vars with your real config.

Run the webserver

pnpm run dev --open

Now it will open a tab in your browser with the website on it.

Backend

The backend runs on purely on go. It hadles api requests, db requests, users, etc

There are two ways of running the backend

• Locally
• In docker

How to run locally

You will need the following

• Latest version of go
• A MariaDB to connect to

Clone the repo

git clone https://github.com/bluekiwidev/Quizzr.git

Then cd into the backend

cd Quizzr/backend

Copy over the .env example into the src

cp .env.example src/.env

Important

Remember to fill out the dummy .env vars with your real config.

cd into the src folder

cd src/

Install the deps

go mod tidy

Build the app

go build -o Quizzr.exe .

Run the app

./Quizzr.exe

How to run with docker

You will need the following

• Latest version of docker

Clone the repo

git clone https://github.com/bluekiwidev/Quizzr.git

Then cd into the backend

cd Quizzr/backend

Edit the docker compose to match your config

nano docker-compose.yml

Important

Remember to fill out the dummy .env vars with your real config.

Run the docker compose stack

docker compose up