https://github.com/rei-x/memory-game
Realtime multiplayer memory game
https://github.com/rei-x/memory-game
firebase typescript
Last synced: 2 months ago
JSON representation
Realtime multiplayer memory game
- Host: GitHub
- URL: https://github.com/rei-x/memory-game
- Owner: Rei-x
- License: mit
- Created: 2022-03-07T17:05:53.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-09T15:21:33.000Z (about 4 years ago)
- Last Synced: 2024-10-19T09:03:16.107Z (over 1 year ago)
- Topics: firebase, typescript
- Language: TypeScript
- Homepage: https://kajtekparty.vercel.app
- Size: 1.43 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Multiplayer memory game
Like title says, it's multiplayer memory game, that can be used at a party to make it more fun!
## Features
- ⚡ Realtime updates
- 🥳 Simple login screen, click and play!
- 📷 Personalized photos on cards
- 🛠 Admin panel
- ✅ Live updated scoreboard of players
- 👀 Multiple games at one time
## How to play it?
Right now, you have only test tournament to choose from.
Go to the website kajtekparty.vercel.app with your friends, choose your favorite Mario character and click join under Test game.
Wait a little (serverless functions are slow) and you will be in the lobby.
One person has to be the master of the game. Go to admin panel, login with github and you can control the game.
Now you can start it and play!
After each round kick player that was last, if only one player has left click "win" button next to him.
## How to run it?
1. Rename `.env.local.example` to `.env.local`
You need cloudinary account to supply website with photos for users and cards. Get your API secret, API key and API cloud name and fill `.env.local` file with them.
2. Create Firebase Project or use existing one.
Create `firebaseConfig.json` file in root directory and fill it with JSON data from your firebase config, here is an example, how it should look:
firebaseConfig.json
```json
{
"apiKey": "AIzaSyCDwoHf3kcHn5zdFDScAcxf4Kq0xz6Nvg",
"authDomain": "memory-game.firebaseapp.com",
"databaseURL": "https://memory-game-default-rtdb.europe-west1.firebasedatabase.app",
"projectId": "memory-game",
"storageBucket": "memory-game.appspot.com",
"messagingSenderId": "453582340732",
"appId": "1:453582340732:web:6a658a61g431e774c2f9f9",
"measurementId": "G-H5SHPORBJ1"
}
```
3. Run `npx ts-node cli/createEnvFromJson.ts`, then copy and paste `NEXT_PUBLIC_FIREBASE_CONFIG` to yours `env.local` file.
4. Run `npm install`
5. There we go! Run `npm run dev` launch app!
### Requirements
- Node.js >= 12.22.0
- NPM 2
### Scripts
- `npm run dev` — Starts the application in development mode at `http://localhost:3000`.
- `npm run build` — Creates an optimized production build of your application.
- `npm start` — Starts the application in production mode.
- `npm run type-check` — Validate code using TypeScript compiler.
- `npm run lint` — Runs ESLint for all files in the `src` directory.
- `npm run format` — Runs Prettier for all files in the `src` directory.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for more information.