Repository files navigation

The Homebrewery is a tool for making authentic lookingD&D contentusingMarkdown. It is distributed under the terms of theMIT License.

The easiest way to get started using The Homebrewery is to use iton our website. The code is open source, so feel free toclone it and tinker with it. If you want to make changes to the code, you can runyour own local version for testing by following the installation instructionsbelow.

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

1. installnode, version v16 or higher.

2. installmongodb (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. If you install any version over 6.0, you will have to installMongoDB Shell.
   4. Go to the C:\ drive and create a folder called "data".
   5. Inside the "data" folder, create a new folder called "db".
   6. Open a command prompt or other terminal and navigate to your MongoDB install folder (C:\Program Files\Mongo\Server\6.0\bin).
   7. In the command prompt, run "mongod", which will start up your local database server.
   8. While MongoD is running, open a second command prompt and navigate to the MongoDB install folder.
   9. Search in Windows for "Advanced system settings" and open it.
   10. Click "Environment variables", find the "path" variable, and double-click to open it.
   11. Click "New" and paste in the path to the MongoDB "bin" folder.
   12. Click "OK" three times to close all the windows.
   13. In the second command prompt, run "mongo", which allows you to edit the database.
   14. Typeuse homebrewery to create The Homebrewery database. You should seeswitched to db homebrewery.
   15. Typedb.brews.insertOne({"title":"test"}) to create a blank document. You should see{ acknowledged: true, insertedId: ObjectId("63c2fce9e5ac5a94fe2410cf") }

3. installgit (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 variableNODE_ENV=local to allowthe project to run locally.

You can set thistemporarily (until you close the terminal) in your shell of choice with admin privileges:

• Windows Powershell:$env:NODE_ENV="local"
• Windows CMD:set NODE_ENV=local
• Linux / macOS:export NODE_ENV=local

If you want to add this variablepermanently the steps are as follows:1. Search in Windows for "Advanced system settings" and open it.1. Click "Environment variables".1. In System Variables, click "New"1. Click "New" and writeNODE_ENV as a name andlocal as the value.1. Click "OK" three times to close all the windows.This can be undone at any time if needed.

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

1. npm install
2. npm start

When the Homebrewery server is started for the first time, it will modify the database to create the indexes required for better Homebrewery performance. This may take a few moments to complete for each index, dependent on how much content is in your local database - a brand new, empty database should be done in seconds.

On completion, you should be able to go tohttp://localhost:8000 in your browser and use The Homebrewery offline.

If you had any issue at all, here are some links that may be useful:

• Course on cluster administration, useful for beginners
• Mongo community forums
• Useful Stack Overflow links for your most probable errors:1,2,3

If you still have problems, post inOur Subreddit and we will help you.

Please see the docs here:README.DOCKER.md

Please see the docs here:README.FreeBSD.md

If you just want the stylesheet that is generated to make pages look like theyare from the Player's Handbook, you will find it in thephb.standalone.css file.

If you are developing locally and would like to generate your own, follow theabove steps and then runnpm run phb.

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

You can check out thechangelog.

This project is licensed under theMIT license, which means youare free to use The Homebrewery in any way that you want, except for claimingthat 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 anyimages or resources used.

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

• At the moment, we have a huge backlog ofissues and someof them are outdated, duplicates, or don't contain any useful info. To help, you canmark duplicates, try toreproduce some complex or weird issues, try finding a workaround for areported bug, or just mention our issue managers team to let them know aboutoutdated issues via@naturalcrit/issue-managers.
• Oursubreddit is constantly growing and there are number ofbug reports. Any help with sorting them out is very welcome.
• And of course you can contribute by fixing a bug or implementing a newfeature by yourself, we are waiting for yourpull requests!

Anyway, if you would like to get in touch with the team and discuss/coordinateyour contribution to the project, please join ourgitter chat.