https://github.com/remarkablegames/party-game-template
🥳 Party game template
https://github.com/remarkablegames/party-game-template
game javascript party party-game react template web website
Last synced: about 2 months ago
JSON representation
🥳 Party game template
- Host: GitHub
- URL: https://github.com/remarkablegames/party-game-template
- Owner: remarkablegames
- License: mit
- Created: 2024-01-23T01:31:40.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T04:03:49.000Z (over 1 year ago)
- Last Synced: 2024-10-30T07:13:50.705Z (over 1 year ago)
- Topics: game, javascript, party, party-game, react, template, web, website
- Language: TypeScript
- Homepage: https://remarkablegames.org/party-game-template
- Size: 1.3 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# party-game-template
[](https://github.com/remarkablegames/party-game-template/actions/workflows/build.yml)
🥳 Party game template.
## Stack
- [DriftDB](https://driftdb.com/)
- [MUI](https://mui.com/)
- [React](https://react.dev/)
- [Vite](https://vitejs.dev/)
## Prerequisites
[nvm](https://github.com/nvm-sh/nvm#installing-and-updating):
```sh
brew install nvm
```
## Install
Clone the repository:
```sh
git clone https://github.com/remarkablegames/party-game-template.git
cd party-game-template
```
Use the Node.js version:
```sh
nvm use
```
Install the dependencies:
```sh
npm install
```
Set the environment variables:
```sh
cp .env .env.local
```
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.
Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
The page will reload if you make edits.
You will also see any errors in the console.
### `npm run build`
Builds the app for production to the `dist` folder.
It correctly bundles in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
### `npm run lint`
Runs ESLint.
## License
[MIT](LICENSE)