/D-D-homebrewery

Create authentic looking D&D homebrews using only markdown

Primary LanguageJavaScriptMIT LicenseMIT

The Homebrewery

Homebrewery

The Homebrewery is a tool for making authentic looking D&D content using Markdown. It is distributed under the terms of the MIT License.

Quick Start

The easiest way to get started using The Homebrewery is to use it on our website. The code is open source, so feel free to clone it and 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.

Installation

First, install three programs that The Homebrewery requires to run and retrieve updates:

  1. install node

  2. install mongodb (Community version)

    For the easiest installation, follow these steps:

    1. In the installer, uncheck the option to run as a service.
    2. You can install MongoDB Compass if you want a GUI to view your database documents.
    3. Go to the C:\ drive and create a folder called "data".
    4. Inside the "data" folder, create a new folder called "db".
    5. Open a command prompt or other terminal and navigate to your MongoDB install folder (C:\Program Files\Mongo\Server\4.4\bin).
    6. In the command prompt, run "mongod", which will start up your local database server.
    7. While MongoD is running, open a second command prompt and navigate to the MongoDB install folder.
    8. In the second command prompt, run "mongo", which allows you to edit the database.
    9. Type use homebrewery to create The Homebrewery database. You should see switched to db homebrewery.
    10. Type db.brews.insert({"title":"test"}) to create a blank document. You should see WriteResult({ "nInserted" : 1 }).
    11. Search in Windows for "Advanced system settings" and open it.
    12. Click "Environment variables", find the "path" variable, and double-click to open it.
    13. Click "New" and paste in the path to the MongoDB "bin" folder.
    14. Click "OK" three times to close all the windows.

  3. install git (select the option that allows Git to run from the command prompt).

Checkout the repo (documentation):

git clone https://github.com/naturalcrit/homebrewery.git

Second, 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 / macOS: export NODE_ENV=local

Third, you will need to install the Node dependencies, compile the app, and run it using the two commands:

  1. npm install
  2. npm start

You should now be able to go to http://localhost:8000 in your browser and use The Homebrewery offline.

Running the application via Docker

Please see the docs here: README.DOCKER.md

Running the application on FreeBSD or FreeNAS

Please see the docs here: README.FreeBSD.md

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 file.

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

Issues, Suggestions, and Bugs

If you run into any issues using The Homebrewery or have suggestions for improvement, please submit an issue on GitHub. You can also get help for issues on the subreddit r/homebrewery

Changelog

You can check out the changelog.

License

This project is licensed under the 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.

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.

Contributing

You are welcome to contribute to the development and maintenance of the project! There are several ways of doing that:

  • At the moment, we have a huge backlog of issues and some of them are outdated, duplicates, or don't contain any useful info. To help, you can mark duplicates, try to reproduce some complex or weird issues, try finding a workaround for a reported bug, or just mention our issue managers team to let them know about outdated issues via @naturalcrit/issue-managers.
  • Our subreddit is constantly growing and there are number of bug reports. Any help with sorting them out is very welcome.
  • And of course you can contribute by fixing a bug or implementing a new feature by yourself, we are waiting for your pull requests!

Anyway, if you would like to get in touch with the team and discuss/coordinate your contribution to the project, please join our gitter chat.