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:
The following videos on youtube are recommended to get up to speed with different components of the stack:
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.
make dbpush
to setup database.make seed
to seed database.http://localhost:3000
to view.http://localhost:3001
to manage database.Various make
commands are available; type make help
at the root directory for list of available commands. Most importantly:
make pnpm "add [package]"
if you need to add some packagemake dbpush
to push schema changes to database without creating migration filemake makemigrations
to create migrations file for new database changesThis 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.