mloberg / 5e-database

Database for the D&D 5th Edition API

Home Page:http://dnd5eapi.co/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

5e-database

Build Status Discord

Holds the database for the D&D 5th Edition API at http://dnd5eapi.co/

Talk to us on Discord!

How to run

With Docker

You should be able to build locally and then run the local Docker image.

Without Docker

First 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:refresh

API Issues

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

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.

Code of Conduct

The Code of Conduct can be found here.

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

About

Database for the D&D 5th Edition API

http://dnd5eapi.co/

License:MIT License


Languages

Language:JavaScript 44.4%Language:TypeScript 39.1%Language:Dockerfile 16.5%