Skip to content

dljsjr/homebrewery

 
 

Repository files navigation

The Homebrewery

The Homebrewery is a tool for making authentic looking D&D content using only Markdown. Check it out here.

issues, suggestions, bugs

If you run into any issues using The Homebrewery, please submit an issue here

local dev

Homebrewery is open source, so feel free to clone it, tinker with it, or run your own local version.

pre-reqs (without Docker)

  1. install node
  2. install mongodb

pre-reqs (with Docker)

The docker version only requires a version of Docker that supports the docker compose version 3 file format (Engine 1.13 or newer). The Docker startup provides node and mongodb, no other installation is required.

getting started (without Docker)

  1. clone it
  2. npm install
  3. npm run-script build
  4. npm start

getting started (with Docker)

  1. clone it
  2. docker-compose up in the app directory to start local homebrewery
  3. docker-compose down to shut down

Locally running hombrewery can be reached at http://localhost:8000

standalone PHB stylesheet

If you just want the stylesheet that is generated to make pages look like they are from the Player's Handbook, you will find it here

If you are developing locally and would like to generate your own, follow the above steps and then run npm run phb.

changelog

You can check out the changelog here

license

This project is licensed under MIT

About

Create authentic looking D&D homebrews using only markdown

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 72.3%
  • JavaScript 27.7%