mirror of
https://github.com/naturalcrit/homebrewery.git
synced 2025-12-25 22:42:41 +00:00
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# The Homebrewery
|
|
The Homebrewery is a tool for making authentic looking [D&D content](http://dnd.wizards.com/products/tabletop-games/rpg-products/rpg_playershandbook) using only [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). Check it out [here](http://homebrewery.naturalcrit.com).
|
|
|
|
|
|
### issues, suggestions, bugs
|
|
If you run into any issues using The Homebrewery, please submit an issue [here](/issues)
|
|
|
|
|
|
### local dev
|
|
Homebrewery is open source, so feel free to clone it, tinker with it, or run your own local version.
|
|
|
|
#### pre-reqs
|
|
1. install [node](https://nodejs.org/en/)
|
|
1. install [mongodb](https://www.mongodb.com/)
|
|
|
|
#### getting started
|
|
1. clone it
|
|
1. `npm install`
|
|
1. `npm build`
|
|
1. `npm start`
|
|
|
|
#### 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](https://github.com/stolksdorf/homebrewery/blob/master/phb.standalone.css)
|
|
|
|
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](https://github.com/stolksdorf/homebrewery/blob/master/changelog.md)
|
|
|
|
### license
|
|
|
|
This project is licensed under [MIT](./license)
|