f.weber/homebrewery
0
0
Fork 0
mirror of https://github.com/naturalcrit/homebrewery.git synced 2025-12-31 15:12:39 +00:00
Code Wiki Activity

Merge branch 'master' into compressBrews

Browse Source
This commit is contained in:
Trevor Buckner
2020-01-23 09:48:47 -05:00
committed by GitHub
parent 2efb24d692 aeffec1763
commit 0b8889d0b8
2 changed files with 32 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -1,35 +1,48 @@
# The Homebrewery # 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). The code is open source, so feel free to clone it, tinker with it. If you want to make changes to the code, you can run your own local version for testing by following the installation instructions below.
### issues, suggestions, bugs ### Installation
If you run into any issues using The Homebrewery, please submit an issue [here](/issues). 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 [node](https://nodejs.org/en/)
1. install [mongodb](https://www.mongodb.com/) 1. install [mongodb](https://www.mongodb.com/)
#### getting started Second, download a copy of the repository. If you have git you can do so with
1. clone it ```
git clone https://github.com/naturalcrit/homebrewery.git
```
Third, you will need to add the environment variable `NODE_ENV = local` to allow the project to run locally.
You can set this temporarily in your shell of choice:
* Windows Powershell: `$env:NODE_ENV="local"`
* Windows CMD: `set NODE_ENV=local`
* Linux / OSX: `export NODE_ENV=local`
Fourth, you will need to install the program and run it using the two commands:
1. `npm install` 1. `npm install`
1. `npm build`
1. `npm start` 1. `npm start`
#### standalone PHB stylesheet You should now be able to go to [http://localhost:8000](http://localhost:8000) in your browser and use the Homebrewery offline.
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).
### 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](./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`. 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](./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. 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.

4
client/homebrew/brewRenderer/errorBar/errorBar.jsx
View File

@@ -36,13 +36,13 @@ const ErrorBar = createClass({
const msg = []; const msg = [];
if(this.hasOpenError){ if(this.hasOpenError){
msg.push(<div> msg.push(<div>
An unmatched opening tag means there's an opened tag that isn't closed, you need to close a tag, like this {'</div>'}. Make sure to match types! An unmatched opening tag means there's an opened tag that isn't closed. You need to close your tags, like this {'</div>'}. Make sure to match types!
</div>); </div>);
} }
if(this.hasCloseError){ if(this.hasCloseError){
msg.push(<div> msg.push(<div>
An unmatched closing tag means you closed a tag without opening it. Either remove it, you check to where you think you opened it. An unmatched closing tag means you closed a tag without opening it. Either remove it, or check to where you think you opened it.
</div>); </div>);
} }