https://github.com/therolffr/buzzer-app

SvelteKit + Typescript + Tailwind CSS + SCSS + socket.io buzzer app
https://github.com/therolffr/buzzer-app

Last synced: about 1 month ago
JSON representation

SvelteKit + Typescript + Tailwind CSS + SCSS + socket.io buzzer app

• Host: GitHub
• URL: https://github.com/therolffr/buzzer-app
• Owner: TheRolfFR
• Created: 2023-09-03T19:02:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-06T07:28:47.000Z (over 1 year ago)
• Last Synced: 2024-10-15T10:17:20.457Z (3 months ago)
• Language: Svelte
• Homepage: https://buzzer.therolf.fr/
• Size: 988 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


   Buzzer App



Homemade buzzer app with a mix of good tech


  Player side


    

  

  Game master side


    

  

## Technologies

Front-end: **SvelteKit** combined with **typescript** for the framework, with **Tailwind CSS** and **SCSS** for dynamic styles using `@apply` and `mixins`.

Back-end: **SvelteKit** does the job quickly but it's really **express** and **socket.io** that brings the power for a custom production server allowing advanced routing and sockets together.

## Base project

I used **[8ctopotamus/sveltekit-socketio-chat](https://github.com/8ctopotamus/sveltekit-socketio-chat)** repo as a base and scratched the entire content to build my app on top. I won so much time over the overall setup time.

## How to develop

Install packages with your favorite package manager. I use [pnpm](https://pnpm.io/) to cache my downloaded packages and go faster:

```

pnpm install

```

You can then start the development server:

```

pnpm run dev

```

Open hosts with `--host` to expose your dev server on the network:

```

pnpm run dev --host 0.0.0.0

```

## How to build

To create a production version of your app:

```bash

pnpm run build

```

## Start prod server

To start prod server, you need to run the built production version:

```

node build/index.prod.js

```

or

```

npm run prod

```

 You can use environment variables like `HOST`, `PORTS` and `SOCKET_PATH` to personalize exposed network interface and port.