1
0
mirror of https://github.com/stolksdorf/homebrewery.git synced 2025-12-12 22:15:55 +00:00
Scott Tolksdorf b671161044 Updating changelog
2016-11-07 19:10:38 -05:00
2016-09-24 10:25:10 -04:00
2016-05-28 09:41:05 -04:00
2016-11-07 19:10:38 -05:00
2016-05-28 09:41:05 -04:00
2016-08-20 12:23:24 -04:00
2016-05-28 09:41:05 -04:00
2016-11-07 19:10:38 -05:00

The Homebrewery

Create authentic looking D&D homebrews using only markdown. Check it out here.

Getting started

  1. Make sure you have node
  2. Clone down the repo
  3. In your terminal, head to the repo
  4. Run npm install to get all the dependencies
  5. 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)
  6. Run npm run watch to run the project locally. Should be accessible at localhost:8000
  7. 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 NaturalCrit.

  1. Install Docker
  2. Clone the repo
  3. In the terminal, go to the repo
  4. Build the docker image docker build -t naturalcrit .
  5. Run the docker container docker run -dit -p 8000:8000 naturalcrit
  6. You can check out the website on your computer on port 8000
    1. You may have to use docker-machine env to get the IP address of your docker instance

Changelog

You can check out the changelog here

License

This project is licensed under MIT

Description
No description provided
Readme 14 MiB
Languages
CSS 72.9%
JavaScript 27.1%