Create a Vagabond

Description

This project aims to provide a quick and simple way to generate a Vagabond for the Root RPG. Other than that, this project is not in any way, shape or form related to the original game itself. I just love the game!

Acknowledgements

Kyle Ferrin and Leder Games - the creators of the board game Root: A Game of Woodland Might and Right.
Magpie Games - the creator of the Root RPG.

Parts

This repo currently has 3 parts:

client - Frontend React App bootstrapped with Vite.
backend - Backend logic: GraphQL server goes here.
Database: This project's database currently lives in PlanetScale.
- Locally, it can also be hosted in Docker using a MySQL Container, or use the pscale command to connect to a branch on PlanetScale.

Requirements

Tools

Node v16
- PNPM v7
Docker (optional)
Netlify CLI
PlanetScale CLI (optional)

Accounts

Netlify - For hosting the site
PlanetScale - Serverless MySQL
Cler - For User authentication

Setup

Environment Variables

Copy an .env file out from .env.sample. This will be used by both the Netlify CLI and Prisma.

Running with PlanetScale

After creating a PlanetScale Account, create a new project in the console.
Copy the connection string. This will be the DATABASE_URL in the .env file.

Running with Docker

DATABASE_URL is mysql://root:root@localhost:3306/createvagabondapp.

Starting the services

cp .env.sample .env

# Start the local database with Docker
# If you want to, replace this step with the `pscale` CLI.
docker compose up -d db

# Install Dependencies
npm install

# Start the services
npm run dev

# Or run these 2 scripts in 2 different terminals to start each service separately
npm run dev:backend
npm run dev:client

samhwang / create-a-vagabond