https://github.com/arthur-mdn/buzzer-app.fr
Realtime buzzer WebApp using WebSocket. Made in Vite + React and NodeJS
https://github.com/arthur-mdn/buzzer-app.fr
buzzer buzzer-app multiplayer online-buzzer
Last synced: about 1 year ago
JSON representation
Realtime buzzer WebApp using WebSocket. Made in Vite + React and NodeJS
- Host: GitHub
- URL: https://github.com/arthur-mdn/buzzer-app.fr
- Owner: arthur-mdn
- Created: 2023-10-30T13:46:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-07T12:51:35.000Z (about 2 years ago)
- Last Synced: 2025-01-17T06:22:42.705Z (over 1 year ago)
- Topics: buzzer, buzzer-app, multiplayer, online-buzzer
- Language: JavaScript
- Homepage: https://buzzer-app.fr
- Size: 3.86 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Getting Started with Buzzer-App
A buzzer-app with a server and a client.
Made with React, NodeJS and Socket.io.
Useful for quizzes and games for your parties like blind-test.
## Installation
```bash
git clone https://github.com/arthur-mdn/buzzer-app.git
cd buzzer-app
```
### Install the server dependencies
```bash
cd server
npm install
```
> ⚠️ You will need to duplicate the `.env.example` file to `.env` and update the environment variables.
> ⚠️ You will also need to create a MongoDB database and update the `DB_URI` variable in the server .env file.
### Install the client dependencies
```bash
cd client
npm install
```
> ⚠️ You will need to duplicate the `.env.example` file in to `.env` and update the environment variables.
## Execution
### Launch the server script
In the server directory, you can run this to run the server and listen for connections / sockets.
```bash
cd server
node server.js
```
### Launch the client script
In the client directory, you can run this to run the app in development mode :
```bash
cd client
npm run dev
```
Open [http://localhost:5173](http://localhost:5173) to view it in your browser.