Updated README

This commit is contained in:
Gavin McDonald
2025-04-26 09:39:45 -04:00
parent f7d10a9b4f
commit 24062d1a07
2 changed files with 27 additions and 19 deletions

View File

@@ -1,28 +1,36 @@
# Custom server with TypeScript + Nodemon example
````
# 🃏 Tarokka
The example shows how you can use [TypeScript](https://typescriptlang.com) on both the server and the client while using [Nodemon](https://nodemon.io/) to live reload the server code without affecting the Next.js universal code.
**Tarokka** is a real-time Tarokka card reading app for _Dungeons & Dragons: Curse of Strahd_. It simulates Madam Evas fortune-telling, revealing a heros fate and Strahds secrets, and is built to deliver an authentic, immersive experience for DMs and players alike.
Server entry point is `server.ts` in development and `dist/server.js` in production.
The `dist` directory should be added to `.gitignore`.
![screenshot](public/screenshot.png)
## Deploy your own
You can see it live at:
👉 [https://tarokka.mcmorgans.us](https://tarokka.mcmorgans.us)
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/custom-server)
---
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/next.js/tree/canary/examples/custom-server)
## ✨ Features
## How to use
- 🔮 **Faithful to the Tarokka Deck**: Supports all cards and positions used by Madam Eva's reading.
- 💬 Dynamic prophecy rendering based on card and position
- 🎨 Multiple card styles
- 🧙 **Separate DM and Spectator Views**:
- ⚙️ DM can toggle what information is visible to players.
- Every action (flipping cards, settings changes) is broadcast live to connected users.
- 🌐 Fully browser-based — no accounts or installs
- 📱 Mobile-friendly UI
- 🔁 **WebSocket-Powered Real-Time Sync**:
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
---
## 🚀 Getting Started
### Development
```bash
npx create-next-app --example custom-server custom-server-app
```
```bash
yarn create next-app --example custom-server custom-server-app
```
```bash
pnpm create next-app --example custom-server custom-server-app
```
git clone https://github.com/mcdoh/tarokka.git
cd tarokka
npm install
npm run dev
````