Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miljan-code/keyboardz
Multiplayer monkeytype clone
https://github.com/miljan-code/keyboardz
Last synced: 7 days ago
JSON representation
Multiplayer monkeytype clone
- Host: GitHub
- URL: https://github.com/miljan-code/keyboardz
- Owner: miljan-code
- Created: 2023-08-11T09:28:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-12T07:39:48.000Z (about 1 year ago)
- Last Synced: 2024-10-16T05:47:54.874Z (21 days ago)
- Language: TypeScript
- Homepage:
- Size: 622 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Keyboardz — Multiplayer typing game
Keyboardz is multiplayer typing test game where users can compete against each
other in real-time. Project is built with [Next.js](https://nextjs.org),
[Tailwind](https://tailwindcss.com/), [Drizzle ORM](https://orm.drizzle.team), [NextAuth](https://next-auth.js.org/) and
[TypeScript](https://typescriptlang.org/).
## Features
- Single-player typing tests
- Multiplayer typing tests with Socket.io
- Typing stats
- Multiple themes
- etc...
## Usage
Clone this repo
```bash
git clone https://github.com/miljan-code/keyboardz.git
```
Install necessary dependencies
```bash
npm install
# or
yarn
# or
pnpm install
```
Fill up the environment variables
```env
NODE_ENV="development"
DATABASE_URL=""
NEXTAUTH_URL="http://localhost:3000"
NEXTAUTH_SECRET=""
GOOGLE_CLIENT_ID=""
GOOGLE_CLIENT_SECRET=""
NEXT_PUBLIC_SITE_URL="http://localhost:3000"
```
Run the development server
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
## Demo
Try it out here (Multiplayer not available in demo because project is hosted on Vercel Serverless, so websockets not available)
[https://keyboardz.miljan.xyz/](https://keyboardz.miljan.xyz/)