TheNinjaRPG

TheNinjaRPG

Source code for TheNinja-RPG

Stars: 58

Visit
 screenshot

TheNinja-RPG is the official source code for the game www.TheNinja-RPG.com. It relies on external services for authentication, websockets, and database. The setup involves signing up for free accounts on services like Clerk, Planetscale, Pusher, and Upstash. The project is bootstrapped using VScode devcontainer and docker for easy setup. Various make commands are available for local development. The source code is released with no license to protect its exclusivity.

README:

🎉 TheNinja-RPG - Core 4 🎉

This is the official source code for the game www.TheNinja-RPG.com.

💻 Setting up locally

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.

  • Run make dbpush to setup database.
  • Run make seed to seed database.
  • Go to http://localhost:3000 to view.
  • Go to http://localhost:3001 to manage database.

🔖 Local Development Guide

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 dbpush to push schema changes to database without creating migration file
  • Use make makemigrations to create migrations file for new database changes

🔒 Licensing

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.

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for TheNinjaRPG

Similar Open Source Tools

For similar tasks

For similar jobs