Skip to content

mg3-codes/d-d-spell-finder

Repository files navigation

D&D Spell Finder 🧙 + 🕵️

About 📣

Tired of flipping through your book to find details on a specific spell for your D&D character? Use this website (dnd-spells.mg3.codes) to search, filter, and export spells as spreadsheets or cards.

Building 🧱

  1. Install yarn modern
  2. Clone code
  3. Run yarn in project root
  4. Run yarn dev to start development server

Running Tests 🔬

Tests are run using Cypress. It is recommended that you run the tests before opening a pull request. They will run automatically when a pull request is opened and are required to pass before merging.

The tests are run against the Chrome browser. It is recommended that you also run them against chrome.

  1. Open two terminals
  2. In one terminal run yarn build-test && yarn preview
  3. In the other terminal run yarn cypress open to run the tests using the GUI or run yarn cypress run --browser chrome to run without the GUI.

Contributing 🧑‍💻

New / Missing / Updated Spells 🪄

If you just found an issue with a spell or think a new one should be added, the best way to let us know is to file an issue.

If you are comfortable coding you could even submit a PR!

Code

See CONTRIBUTING.md for instructions on how to contribute.

Attribution

This work includes material taken from the System Reference Document 5.1 (“SRD 5.1”) by Wizards of the Coast LLC and available at https://dnd.wizards.com/resources/systems-reference-document. The SRD 5.1 is licensed under the Creative Commons Attribution 4.0 International License available at https://creativecommons.org/licenses/by/4.0/legalcode.