mirror of
https://github.com/naturalcrit/homebrewery.git
synced 2025-12-24 18:32:41 +00:00
Adding instructiosn to the readme
This commit is contained in:
15
README.md
15
README.md
@@ -1,2 +1,15 @@
|
||||
# NaturalCrit
|
||||
An encounter manager for Gms while playing D&D
|
||||
A tool suite for DMs to use for D&D
|
||||
|
||||
|
||||
### Getting started
|
||||
1. Make sure you have [node](https://nodejs.org/en/)
|
||||
1. Clone down the repo
|
||||
1. In your terminal, head to the repo
|
||||
1. Run `npm install` to get all the dependacies
|
||||
1. Run `gulp fresh`, this will compile and build all the needed libraries (this only has to be done once, unless you add more libs)
|
||||
1. Run `gulp` to run the project locally. Should be accessible at `localhost:8000`
|
||||
|
||||
**Notes:** I use Mongo as the database, so if you'd like to interact with that, make sure you have that installed.
|
||||
|
||||
Have fun!
|
||||
|
||||
Reference in New Issue
Block a user