Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 2.68 KB

README.md

File metadata and controls

57 lines (39 loc) · 2.68 KB

Fuiz

Host live quizzes freely

Fuiz icon

License

Dependencies

This is the code for the website (developed in Svelte). It relies on two other components to function properly:

Additionally, the website relies on Cloudflare APIs for viewing the library and basic user authentication and storage. If you want to enable these features you need to use wrangler.

Due to the nature of fast development, it's not a goal at the moment to make self-hosting as easy as possible. Once things stabilize a bit more we will put an effort towards providing docker images.

Developing

After installing dependancies with bun install, start a development server:

bun run dev

While we use bun ourselves, npm should work just as fine.

You might need the following environment variables (.env.local):

# the link to the current hosted version, production: fuiz.us
PUBLIC_DISPLAY_PLAY_URL="localhost:5173"
# same as above but with the actual protocol, production: https://fuiz.us
PUBLIC_PLAY_URL="http://localhost:5173"
# the game backend, production: https://api.fuiz.us
PUBLIC_BACKEND_URL="http://localhost:8787"
# same as above but a websocket url, production: wss://api.fuiz.us
PUBLIC_WS_URL="ws://localhost:8787"
# image server url, in pproduction: https://corkboard.fuiz.us
PUBLIC_CORKBOARD_URL="http://localhost:43907"

You might also need:

# Needed for Auth.js, can be generated with: bunx/npx auth secret
AUTH_SECRET={random string}
# Google Auth Client Id and Secret Key
AUTH_GOOGLE_ID=
AUTH_GOOGLE_SECRET

Status

The live components' status can be accessed on status.fuiz.us.