5e-srd-api

REST API to access D&D 5th Edition SRD API

Talk to us on Discord!

How to Run

You can make sure you have the latest version of the database by running:

docker-compose pull

Then run it with docker-compose:

docker-compose up --build

Make API requests by using the root address: http://localhost:3000/api/

You should get a response with the available endpoints for the root:

{
  "ability-scores": "/api/ability-scores",
  "classes": "/api/classes",
  "conditions": "/api/conditions",
  "damage-types": "/api/damage-types",
  "equipment-categories": "/api/equipment-categories",
  "equipment": "/api/equipment",
  "features": "/api/features",
  "languages": "/api/languages",
  "magic-schools": "/api/magic-schools",
  "monsters": "/api/monsters",
  "proficiencies": "/api/proficiencies",
  "races": "/api/races",
  "skills": "/api/skills",
  "spells": "/api/spells",
  "starting-equipment": "/api/starting-equipment",
  "subclasses": "/api/subclasses",
  "subraces": "/api/subraces",
  "traits": "/api/traits",
  "weapon-properties": "/api/weapon-properties"
}

Data Issues

If you see anything wrong with the data itself, please open an issue or PR over here.

Running Tests

Unit Tests

You can run unit tests locally by using the command: npm run test:unit

Integration Tests

Integration tests need to be ran in the API docker container for them to function properly. In order to run integration tests locally you can use the command: npm run test:integration:local

Contributing

• Fork this repository
• Create a new branch for your work
• Push up any changes to your branch, and open a pull request. Don't feel it needs to be perfect — incomplete work is totally fine. We'd love to help get it ready for merging.