Holds the database for the D&D 5th Edition API at http://dnd5eapi.co/
Talk to us on Discord!
You should be able to build locally and then run the local Docker image. This can be done one of two ways:
- If you just need an image and you aren't running an M1:
docker run ghcr.io/5e-bits/5e-database:latest- If you're running an M1 or you want to test changes that you've made to the Database:
docker build -t 5e-database .
docker run -i -t 5e-database:latestFirst you need to make sure you have MongoDB installed locally.
You can load this data locally by running:
MONGODB_URI=mongodb://localhost/5e-database npm run db:refreshIf you see anything wrong with the API and not the data, please open an issue or PR over here.
- 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.
- We use Semantic Release so here are the PR naming convetions:
| Commit message | Release type |
|---|---|
| fix(pencil): stop graphite breaking when too much pressure applied | Patch Fix Release |
| feat(pencil): add 'graphiteWidth' option | Minor Feature Release |
| perf(pencil): remove graphiteWidth option BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reasons. |
Major Breaking Release (Note that the BREAKING CHANGE: token must be in the footer of the commit) |
The Code of Conduct can be found here.
This project is licensed under the terms of the MIT license. The underlying m 5EBE aterial is released using the Open Gaming License Version 1.0a