5etools-src

(โ˜… 500)

A mirror.

  • .dockerignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .node-version
  • .npmrc
  • .prettierrc.js
  • .stylelintrc.json
  • 5etools.html
  • actions.html
  • adventure.html
  • adventures.html
  • android-chrome-192x192.png
  • android-chrome-256x256.png
  • android-chrome-384x384.png
  • android-chrome-512x512.png
  • apple-touch-icon-120x120.png
  • apple-touch-icon-152x152.png
  • apple-touch-icon-167x167.png
  • apple-touch-icon-180x180.png
  • apple-touch-icon-360x360.png
  • backgrounds.html
  • bastions.html
  • bestiary.html
  • blocklist.html
  • book.html
  • books.html
  • browserconfig.xml
  • changelog.html
  • charcreationoptions.html
  • classes.html
  • conditionsdiseases.html
  • CONTRIBUTING.md
  • converter.html
  • crcalculator.html
  • cspell.json
  • cultsboons.html
  • decks.html
  • deities.html
  • dmscreen.html
  • Dockerfile
  • encountergen.html
  • eslint.config.mjs
  • favicon-128x128.png
  • favicon-144x144.png
  • favicon-16x16.png
  • favicon-256x256.png
  • favicon-32x32.png
  • favicon-48x48.png
  • favicon-64x64.png
  • favicon.svg
  • favicon_preview.png
  • favicon_source_files.zip
  • feats.html
  • homecrafts.html
  • index.html
  • inittrackerplayerview.html
  • ISSUE_TEMPLATE.md
  • items.html
  • jest.config.json
  • jsconfig.json
  • langdemo.html
  • languages.html
  • LICENSE.md
  • lifegen.html
  • lootgen.html
  • makebrew.html
  • makecards.html
  • managebrew.html
  • manageprerelease.html
  • manifest.webmanifest
  • maps.html
  • maskable_icon.png
  • mstile-144x144.png
  • mstile-150x150.png
  • mstile-310x150.png
  • mstile-310x310.png
  • mstile-70x70.png
  • names.html
  • NOTES_AUTOMATION.md
  • NOTES_FAVICON.md
  • objects.html
  • open-search.xml
  • optionalfeatures.html
  • package-lock.json
  • package.json
  • plutonium.html
  • privacy-policy.html
  • psionics.html
  • quickreference.html
  • races.html
  • README.md
  • recipes.html
  • renderdemo.html
  • rewards.html
  • safari-pinned-tab.svg
  • safari_pin_preview.png
  • search.html
  • spells.html
  • statgen.html
  • SVGs.zip
  • sw-injector-template.js
  • sw-template.js
  • tables.html
  • touch_bar_preview.png
  • trapshazards.html
  • variantrules.html
  • vehicles.html

# Installation Guide

1. Get the code
git clone https://github.com/5etools-mirror-3/5etools-src

Downloads the entire project code from GitHub to your computer.

cd 5etools-src

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t 5etools-src .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 5etools-src

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation