https://github.com/ll782/pathfinder-tools
[Pre-alpha] Homegrown tools for gamesmastering Pathfinder, a table top roleplaying adventure game
https://github.com/ll782/pathfinder-tools
Last synced: 9 months ago
JSON representation
[Pre-alpha] Homegrown tools for gamesmastering Pathfinder, a table top roleplaying adventure game
- Host: GitHub
- URL: https://github.com/ll782/pathfinder-tools
- Owner: LL782
- Created: 2020-07-20T20:28:34.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-10-24T22:52:32.000Z (over 2 years ago)
- Last Synced: 2025-04-04T09:11:46.186Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://www.pathfindertools.com
- Size: 5.43 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pathfinder Tools
🌐 Website: [**www.pathfindertools.com**](https://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**]((https://en.wikipedia.org/wiki/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**](https://github.com/LL782/pathfinder-tools/issues/) link for features requests, bug reports and general ideas
- 👩🏻💻 Use [**Pull requests**](https://github.com/LL782/pathfinder-tools/pulls/) to present codebase changes (including fixing typos, etc.)
- ✉️ Feel free to [**email me**](mailto:hello@laurencelord.co.uk) 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](https://reactjs.org/) with the [NEXT.js](https://nextjs.org/) framework. It gets deployed on to the [Vercel Platform](https://vercel.com) via a [Github](https://github.com) action.
_Note that I'll use the words "website" and "app" interchangeably._
### Getting started
To run the website locally, you will need [**Node**](https://nodejs.org/en/) installed on your computer, if you don't already.
You'll also need [**Yarn**](https://yarnpkg.com/) (or [**npm**](npmjs.com/)) 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:
```bash
yarn
```
To start the running the website:
```bash
yarn dev
```
Visit [http://localhost:3000](http://localhost:3000) and you should see the website running in dev mode.