thebestjohn / fari-app

Play Table-Top RPGs Online without the headache

Fari - Play Table-Top RPGs Online Without the Headache

This repo contains the source code that powers Fari, the open source virtual table-top platform.

Feature Requests

You can request new features here

Bug Report

If you found an issue with the app, you can report the bug here

Development

If you want to make a contribution to Fari, you will need to fork / clone this repo and follow the following steps to run the app locally.

Prerequisites

1. Install Node ^16.2.0 (to match engine property in package.json)

Installation

Fari relies on Node and the Node Package Manager to download its dependencies and run.

If you are using the proper node and npm version, you then need to install Fari's dependencies

npm install

Once the dependencies are installed, Fari will also build some of it's static content (e.g. the content of the SRD) using 11ty which will convert the markdown files to HTML files insides a _site directory.

Running the application

If you want to run Fari on your machine, simply run:

npm run start

This will start and bundle the app using ViteJS and make it available on http://localhost:1234

ViteJS will also update your browser's content (using React Refresh) anytime you do save a file on the disk.

Updating document content

Fari as a couple of markdown files that it transforms to HTML files so that they can be used inside the app.

This process is done at build time to prevent useless calculation on the client side.

Since it takes a bit of time do transform those documents, and it's not everyday that you modify those documents, the npm start doesn't do that process that default.

If you want to update a markdown file and see the changes reflected right away in your browser, you can run

npm run start:all

This will run the normal server, but also rebuild the markdown files everytime you modify them.

Special Thanks

• Netlify for hosting Fari.
• Lokalise for providing internalization feature for Fari.
• Canny for providing user feedback features for Fari.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

rpdeshaies 💻 📖 🌍 👀	Davide Vernassa 🌍	corrina 🌍	Erynus 🌍	hattivatt 🌍	pedrogsribeiro 🌍	nfregoso 💻
ConDar15 💻	Jorge Diz Pico 🌍	Thomas Bearse 💻	1d12monos 🌍	chocoporto 🌍	Gpoitras 💻	Christie Kennedy 💻

This project follows the all-contributors specification. Contributions of any kind welcome!