Open5e is a community project driven by a small number of volunteers in their spare time. We welcome any and all contributions!

Useful places to check out:

• Our discord where we discuss the project and generally pal around. Bring your best memes.
• The project org homepage which has links to our roadmaps and other resources
• The API repo if you're more interested in python
• The website! published from this repo

Open5e uses the Nuxt3 framework for Vue3, which takes care of a lot of the architectural work for the frontend layer while allowing a large amount of flexibility.

After cloning this repo, from /open5e

# install dependencies
$ npm install # Or yarn install

# Optional: point it at a real API by setting API_URL=https:someurl.com
# serve with hot reload at localhost:3000. If you
$ npm run dev

By default, the UI layer will point to the live API. If you want to change this, you can set an environment variable for "API_URL" and direct it to a local API source. (Usually localhost:8888 if you're using the api at https://github.com/eepMoody/open5e-api

Other build options:

# build for production and launch server
$ npm start

# generate static project
$ npm run generate

For detailed explanation on how things work, checkout the Nuxt.js docs.