/tarrasqueapp

[WIP] Free & open-source virtual tabletop for Dungeons & Dragons

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Tarrasque App

Tarrasque App is a free and open-source virtual tabletop software for playing Dungeons & Dragons. It allows you to create and manage your own campaigns, maps, and characters, and provides a simple and intuitive interface for playing D&D online or in-person.

Note Tarrasque App is the official open-source successor to Tarrasque.io. You can read the announcement regarding the new version here.

Warning This project is in pre-alpha and is not yet ready for public use. Please do not use this in production or with real data. We are not responsible for any data loss or other issues that may occur.

Requirements

  • Node.js (v18.12.1 or higher)
  • Yarn (v1.22.19 or higher)
  • Docker (v20.10.21 or higher)
  • Docker Compose (v2.13.0 or higher)
  • Supported Platforms: MacOS, Linux, Windows with WSL 2

WSL Requirements

Install Node and Yarn in your WSL 2 distribution, then install Docker Desktop and enable the WSL 2 Backend for your WSL 2 distribution.

Installation

To install Tarrasque App, run the following commands to install the dependencies and set up the environment variables:

./bin/setup.sh
cp .env.example .env

Then, edit the .env file to set the necessary environment variables.

Running the Server

To start the development server, run:

tarrasque docker up --db

This will start the server and the local database service at http://localhost.

To start the production server, run:

tarrasque docker up --prod

This will start the production server at http://localhost.

Database Management

To create the database, run:

yarn server prisma db push

To generate the Prisma client types, run:

yarn server prisma generate

To create a database migration, run:

yarn server prisma migrate dev --name <migration-name>

To browse the database using Prisma Studio, run:

yarn server prisma studio

Contributing

Contributions are welcome! Please see the CONTRIBUTING file for more information. If you have any questions, feel free to reach out to us on Discord. We'd love to hear from you! 😊

License

Tarrasque App is licensed under the GNU Affero General Public License. See the LICENSE file for more information.