https://github.com/5e-bits/5e-database
Database for the D&D 5th Edition API
https://github.com/5e-bits/5e-database
database hacktoberfest json
Last synced: 24 days ago
JSON representation
Database for the D&D 5th Edition API
- Host: GitHub
- URL: https://github.com/5e-bits/5e-database
- Owner: 5e-bits
- License: mit
- Created: 2016-12-21T22:40:11.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2026-05-23T16:07:05.000Z (28 days ago)
- Last Synced: 2026-05-23T18:07:17.897Z (28 days ago)
- Topics: database, hacktoberfest, json
- Language: TypeScript
- Homepage: http://dnd5eapi.co/
- Size: 7.59 MB
- Stars: 895
- Watchers: 30
- Forks: 423
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 5e-database
[](https://discord.gg/TQuYTv7)
Holds the database for the D&D 5th Edition API at http://dnd5eapi.co/
Talk to us [on Discord!](https://discord.gg/TQuYTv7)
## How to run
### With Docker
You should be able to build locally and then run the local Docker image. This can be done one of two ways:
1. If you just need an image and you aren't running an M1:
```bash
docker run ghcr.io/5e-bits/5e-database:latest
```
2. If you're running an M1 or you want to test changes that you've made to the Database:
```bash
docker build -t 5e-database .
docker run -i -t 5e-database:latest
```
### Without Docker
First you need to make sure you have [MongoDB installed locally.](https://docs.mongodb.com/manual/installation/)
You can load this data locally by running:
```bash
MONGODB_URI=mongodb://localhost/5e-database npm run db:refresh
```
## API Issues
If you see anything wrong with the API and not the data, please open an issue or PR over [here](https://github.com/5e-bits/5e-srd-api).
## 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.
* 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) |
## Code of Conduct
The Code of Conduct can be found [here.](https://github.com/5e-bits/5e-database/wiki/Code-of-Conduct)
## License
This project is licensed under the terms of the MIT license. The underlying material
is released using the [Open Gaming License Version 1.0a](https://www.wizards.com/default.asp?x=d20/oglfaq/20040123f)
## Contributors
