/pathfinder-tools

[Pre-alpha] Homegrown tools for gamesmastering Pathfinder, a table top roleplaying adventure game

Primary LanguageTypeScript

Pathfinder Tools

🌐 Website: www.pathfindertools.com

🔨 Status: pre-alpha (meaning very far from being fully featured)


The website is a collection of tools for running Pathfinder

  • 🌱 There's not much here yet - just a few scraps and the beginning of a structure
  • 👷🏽‍♀️ This is a "side project of a hobby" – forever work in progress
  • 🔨 It's open source and here on GitHub so you can build it too

Contributing

Please get in touch with any comments, offering or suggestions. Also,

  • 💡 Use this Issues link for features requests, bug reports and general ideas
  • 👩🏻‍💻 Use Pull requests to present codebase changes (including fixing typos, etc.)
  • ✉️ Feel free to email me if you like

Whatever your technical level is you're invited to get involved with code, content, ideas, etc.


Developer notes

It's all a bit quick and dirty in terms of the code (remember this is a side project of a hobby).

The website is built with React with the NEXT.js framework. It gets deployed on to the Vercel Platform via a Github action.

Note that I'll use the words "website" and "app" interchangeably.

Getting started

To run the website locally, you will need Node installed on your computer, if you don't already.

You'll also need Yarn (or npm) to manage packages.

Run these commands in your Terminal

Once you have your dependancies (Node and Yarn) run the following scripts from your Terminal.

To install or upgrade the app:

yarn

To start the running the website:

yarn dev

Visit http://localhost:3000 and you should see the website running in dev mode.