mirror of
https://github.com/stolksdorf/homebrewery.git
synced 2025-12-12 22:15:55 +00:00
56048ab9363c0cb4596c92f54da2b6db7b356ab5
The Homebrewery
Create authentic looking D&D homebrews using only markdown. Check it out here.
If you want to locally run your own version, or just play around with the code you see here, follow the instructions below.
Getting started running your own version locally.
- Make sure you have node
- Clone down the repo
- In your terminal, head to the repo
- Run
npm installto get all the dependencies - Run
npm run libs, this will compile and build all the needed libraries (this only has to be done once, unless you add more libs) - Run
npm run watchto run the project locally. Should be accessible atlocalhost:8000 - Any changes to files within the project will be detected and the project will automatically re-build
Notes: If you'd like to create and edit homebrews, you'll need to have MongoDB installed and running.
Have fun!
Docker Image
You can use Docker to get up and running with the Homebrewery.
- Install Docker
- Clone the repo
- In the terminal, go to the repo
- Build the docker image
docker build -t naturalcrit . - Run the docker container
docker run -dit -p 8000:8000 naturalcrit - You can check out the website on your computer on port 8000
- You may have to use
docker-machine envto get the IP address of your docker instance
- You may have to use
Changelog
You can check out the changelog here
License
This project is licensed under MIT
Description
Languages
CSS
72.9%
JavaScript
27.1%