diff --git a/README.md b/README.md index 39a9d88..f5bce83 100644 --- a/README.md +++ b/README.md @@ -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 Evaโ€™s fortune-telling, revealing a heroโ€™s fate and Strahdโ€™s 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 +```` diff --git a/public/screenshot.png b/public/screenshot.png new file mode 100644 index 0000000..b079581 Binary files /dev/null and b/public/screenshot.png differ