kwikquiz

README

kwikquiz

Quiz-platform written in Golang and HTMX

Run using Docker Compose

Requirements: Docker and Docker Compose installed

docker-compose up

The app will be available at http://localhost:3000

How to run locally

Requirements: Go 1.22 installed

go run cmd/main.go

The app will be available at http://localhost:3000

Running during development

Requirements: Go 1.22, air installed

Air is a tool that auto rebuilds and runs the application when changes are detected. DEBUG=1 flag is used to set log level to debug.

DEBUG=1 air

Running in production mode

To run in production mode, set the environment variable PROD to true or 1.

PROD=1 go run cmd/main.go

SECURITY WARNING

If you plan to host the app on the web, you should change .env file so that the password to your database is not known to the public.

Contributing

Please read the CONTRIBUTING.md file for more information on how to contribute to this project.