{"id":13457676,"url":"https://github.com/wanderers-guide/wanderers-guide","last_synced_at":"2025-03-24T14:32:18.514Z","repository":{"id":210328141,"uuid":"714466034","full_name":"wanderers-guide/wanderers-guide","owner":"wanderers-guide","description":"A character builder and digital toolbox for Pathfinder and Starfinder Second Edition.","archived":false,"fork":false,"pushed_at":"2024-10-30T00:42:26.000Z","size":82623,"stargazers_count":16,"open_issues_count":43,"forks_count":9,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-30T02:52:41.117Z","etag":null,"topics":["character-sheet","dnd","dnd-tools","dnd5e","pathfinder","pathfinder2e","pf2e","sf2e","starfinder","starfinder2e","ttrpg"],"latest_commit_sha":null,"homepage":"https://wanderersguide.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wanderers-guide.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-04T23:30:35.000Z","updated_at":"2024-10-30T00:42:29.000Z","dependencies_parsed_at":"2024-11-12T18:15:16.940Z","dependency_job_id":null,"html_url":"https://github.com/wanderers-guide/wanderers-guide","commit_stats":null,"previous_names":["wanderers-guide/wanderers-guide-remaster","wanderers-guide/wanderers-guide"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanderers-guide%2Fwanderers-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanderers-guide%2Fwanderers-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanderers-guide%2Fwanderers-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanderers-guide%2Fwanderers-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wanderers-guide","download_url":"https://codeload.github.com/wanderers-guide/wanderers-guide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245289636,"owners_count":20591111,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["character-sheet","dnd","dnd-tools","dnd5e","pathfinder","pathfinder2e","pf2e","sf2e","starfinder","starfinder2e","ttrpg"],"created_at":"2024-07-31T09:00:33.373Z","updated_at":"2025-03-24T14:32:18.507Z","avatar_url":"https://github.com/wanderers-guide.png","language":"TypeScript","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"![Wanderer's Guide](https://legacy.wanderersguide.app/images/logo.png \"Wanderer's Guide logo\")\n\n## Quick links\n\n- [Legacy App Repo](https://github.com/wanderers-guide/wanderers-guide-legacy)\n- [Web App](./frontend)\n- [Serverless API](./supabase)\n\n## Description\n\n\u003e This is currently undergoing significant changes as the remaster is being built from the legacy app. More updates will be coming soon!\n\nTo 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.\n\n## Prerequisites\n1. Install node.js using the instructions here: \u003chttps://nodejs.org/en/download\u003e\n1. Install Docker \u003chttps://www.docker.com/\u003e\n1. Install the supabase CLI for your OS following the instructions: \u003chttps://supabase.com/docs/guides/cli/getting-started\u003e\n1. Install Postgres \u003chttps://www.postgresql.org/\u003e, need `psql` (the client command line)\n\n## Setup\n\n1. Clone this repo `git clone https://github.com/wanderers-guide/wanderers-guide.git` and run `cd wanderers-guide`\n1. Run `supabase start` to initialize supabase locally, this will print a few details about the supabase local development setup that will be required later\n1. Go into the `data/` folder and run `./create-db.sh \u003cDB_URL\u003e` (replace `\u003cDB_URL\u003e` with value obtained in step 3; default `postgresql://postgres:postgres@127.0.0.1:54322/postgres`). This will create all the tables needed\n1. Go into the `frontend/` directory\n1. Copy `.env.local.template` to `.env.local` and replace the placeholder variables in `.env.local`\n    - replace `\u003cAPI_URL\u003e` and `\u003cANON_KEY\u003e` with the values obtained in step 3\n    - `\u003cDDDICE_API_KEY\u003e` needs to be replaced with the API key to [dddice](https://dddice.com)\n    - Replacing `\u003cDDDICE_API_KEY\u003e` can be omitted, but it won't be possible to roll virtual dice then\n    - The API key can be generated by creating a [dddice](https://dddice.com) account, visitng [\"My Account\" -\u003e \"Developers\"](https://dddice.com/account/developer) and clicking on \"Create API Key\"\n1. Run `npm i`\n1. Run `npm run dev` - this will run the frontend\n1. In another terminal window run `supabase functions serve` at project root level to initialize the backend\n\n### Creating a user\n\nTo properly access the website you need to register a user.\n\n1. Go to the local supabase studio URL (default \u003chttp://127.0.0.1:54323\u003e)\n2. In the authentication page, create a new user with email and password. Copy the User UUID generated\n3. Go to the Table Editor page and select the `public_user` table. Insert the following snippet into the table (Insert -\u003e Paste Text); make sure to substitute the \"UUID HERE\" string for the User UUID generate in step 2\n```csv\nid,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\n1,2024-04-03 21:30:01.720023+00,UUID HERE,User Name,,,,false,false,false,,,,,true,\n```\n4. Login with the email and password\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwanderers-guide%2Fwanderers-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwanderers-guide%2Fwanderers-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwanderers-guide%2Fwanderers-guide/lists"}