f.weber/homebrewery
0
0
Fork 0
mirror of https://github.com/naturalcrit/homebrewery.git synced 2025-12-24 18:32:41 +00:00
Code Wiki Activity

Updating README.md with more detailed install instructions and reformatting.

Browse Source
This commit is contained in:
Christian Brickhouse
2019-03-14 00:32:28 -07:00
committed by Trevor Buckner
parent 81c361bfb8
commit ef325e2617
1 changed files with 28 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -1,35 +1,46 @@
# The Homebrewery
The Homebrewery is a tool for making authentic looking [D&D content](https://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](https://homebrewery.naturalcrit.com).
The Homebrewery is a tool for making authentic looking [D&D content](https://dnd.wizards.com/products/tabletop-games/rpg-products/rpg_playershandbook) using [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). It is distributed under the terms of the [MIT License](./license).
## Quick Start
The easiest way to get started using the Homebrewery is to use it [on our website](https://homebrewery.naturalcrit.com). If you have larger brews or want to make changes to the code follow the installation instructions below.
### issues, suggestions, bugs
If you run into any issues using The Homebrewery, please submit an issue [here](/issues).
### Installation
First, install two programs that the Homebrewery requires to run.
### local dev
The 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
Second, download a copy of the repository. If you have git you can do so with
```
git clone https://github.com/naturalcrit/homebrewery.git
```
Third, you will need to modify line 9 of the file server.js so that it looks like:
```
//app.use(require('./server/forcessl.mw.js'));
```
Fourth, you will need to install the program and run it using the two commands:
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).
You should now be able to go to [http://localhost:8000](http://localhost:8000) in your browser and use the Homebrewery offline.
### 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 in the [phb.standalone.css](./blob/master/phb.standalone.css) file.
If you are developing locally and would like to generate your own, follow the above steps and then run `npm run phb`.
### changelog
## Issues, Suggestions, and Bugs
If you run into any issues using The Homebrewery or have suggestions for improvement, please submit an issue [on GitHub](/issues). You can also get help for issues on the subreddit [r/homebrewery](https://www.reddit.com/r/homebrewery)
You can check out the changelog [here](https://github.com/stolksdorf/homebrewery/blob/master/changelog.md).
## Changelog
### license
You can check out the [changelog](./blob/master/changelog.md).
This project is licensed under [MIT](./license). Which means you are free to use The Homebrewery in any way that you want, except for claiming that you made it yourself.
## License
This project is licensed under the [MIT license](./license). Which means you are free to use The Homebrewery in any way that you want, except for claiming that you made it yourself.
If you wish to sell or in some way gain profit for what's created on this site, it's your responsibility to ensure you have the proper licenses/rights for any images or resources used.