https://github.com/wanderers-guide/wanderers-guide
A character builder and digital toolbox for Pathfinder and Starfinder Second Edition.
https://github.com/wanderers-guide/wanderers-guide
character-sheet dnd dnd-tools dnd5e pathfinder pathfinder2e pf2e sf2e starfinder starfinder2e ttrpg
Last synced: 7 months ago
JSON representation
A character builder and digital toolbox for Pathfinder and Starfinder Second Edition.
- Host: GitHub
- URL: https://github.com/wanderers-guide/wanderers-guide
- Owner: wanderers-guide
- License: gpl-3.0
- Created: 2023-11-04T23:30:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T00:42:26.000Z (12 months ago)
- Last Synced: 2024-10-30T02:52:41.117Z (12 months ago)
- Topics: character-sheet, dnd, dnd-tools, dnd5e, pathfinder, pathfinder2e, pf2e, sf2e, starfinder, starfinder2e, ttrpg
- Language: TypeScript
- Homepage: https://wanderersguide.app/
- Size: 78.8 MB
- Stars: 16
- Watchers: 3
- Forks: 9
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## Quick links
- [Legacy App Repo](https://github.com/wanderers-guide/wanderers-guide-legacy)
- [Web App](./frontend)
- [Serverless API](./supabase)
## Description
> This is currently undergoing significant changes as the remaster is being built from the legacy app. More updates will be coming soon!
To help contribute, go to the [Legacy App](https://github.com/wanderers-guide/wanderers-guide-legacy/tree/main/services/express) and follow the README there. If you would like to contribute to the rework, come chat to us on the [Wanderers Guide Discord](https://discord.gg/kxCpa6G) and search tag `@developer` in the development channel.
## Prerequisites
1. Install node.js using the instructions here:
1. Install Docker
1. Install the supabase CLI for your OS following the instructions:
1. Install Postgres , need `psql` (the client command line)
## Setup
1. Clone this repo `git clone https://github.com/wanderers-guide/wanderers-guide.git` and run `cd wanderers-guide`
1. Run `supabase start` to initialize supabase locally, this will print a few details about the supabase local development setup that will be required later
1. Go into the `data/` folder and run `./create-db.sh ` (replace `` with value obtained in step 3; default `postgresql://postgres:postgres@127.0.0.1:54322/postgres`). This will create all the tables needed
1. Go into the `frontend/` directory
1. Copy `.env.local.template` to `.env.local` and replace the placeholder variables in `.env.local`
- replace `` and `` with the values obtained in step 3
- `` needs to be replaced with the API key to [dddice](https://dddice.com)
- Replacing `` can be omitted, but it won't be possible to roll virtual dice then
- The API key can be generated by creating a [dddice](https://dddice.com) account, visitng ["My Account" -> "Developers"](https://dddice.com/account/developer) and clicking on "Create API Key"
1. Run `npm i`
1. Run `npm run dev` - this will run the frontend
1. In another terminal window run `supabase functions serve` at project root level to initialize the backend
### Creating a user
To properly access the website you need to register a user.
1. Go to the local supabase studio URL (default )
2. In the authentication page, create a new user with email and password. Copy the User UUID generated
3. Go to the Table Editor page and select the `public_user` table. Insert the following snippet into the table (Insert -> Paste Text); make sure to substitute the "UUID HERE" string for the User UUID generate in step 2
```csv
id,created_at,user_id,display_name,image_url,background_image_url,site_theme,is_admin,is_mod,deactivated,summary,subscribed_content_sources,patreon,organized_play_id,is_developer,is_community_paragon
1,2024-04-03 21:30:01.720023+00,UUID HERE,User Name,,,,false,false,false,,,,,true,
```
4. Login with the email and password