This is the official source code for the game www.TheNinja-RPG.com.
The codebase relies on a variety of external services for e.g. auth, websockets, database, etc. Some of these are next to impossible to replicate locally, but provide free (or very cheap) tiers. To get up and running, it is therefore required to sign up for free accounts on the following services:
- https://clerk.com/ - for auth (required)
- https://uploadthing.com/ - for file uploads (optional)
- https://replicate.com/ - for AI inference (optional)
The following videos on youtube are recommended to get up to speed with different components of the stack:
- The official TheNinja-RPG youtube, TNR DevLog
- Next.js, Clerk, tRPC, Planetscale, tailwind: T3 Stack Tutorial
- Drizzle ORM: DrizzleORM Pitch
To get started, copy app/.env.example to app/.env and fill in all variables related to services (*CLERK*, REPLICATE*, UPLOADTHING*). The project is bootstrapped using VScode devcontainer and docker, making it as easy as possible to get up and running. The recommended way of spinning up locally, therefore, is to open the project in VSCode, and then open the VScode devcontainer in the lower left corner. This should set up the entire development environment.
- Run
make dbpushto setup database. - Run
make seedto seed database. - Go to
http://localhost:3000to view. - Go to
http://localhost:3001to manage database.
Various make commands are available; type make help at the root directory for list of available commands. Most importantly:
- Use
make pnpm "add [package]"if you need to add some package - Use
make dbpushto push schema changes to database without creating migration file - Use
make makemigrationsto create migrations file for new database changes
This source code is released with no license, meaning that the work is under exclusive copyright. We do not wish for countless of online copies to be released and float around.