mirror of
https://github.com/naturalcrit/homebrewery.git
synced 2025-12-26 16:02:38 +00:00
Merge pull request #203 from lasseborly/minorDocumentationChanges
Minor documentation changes
This commit is contained in:
15
README.md
15
README.md
@@ -6,11 +6,10 @@ Create authentic looking D&D homebrews using only markdown. Check it out [here](
|
||||
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
|
||||
2. Run `npm install -g gulp` to install the gulp build tool
|
||||
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`
|
||||
2. Any changes to files within the proejct will be detected and the propject will automatically re-build
|
||||
1. Run `npm install` to get all the dependencies
|
||||
1. 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)
|
||||
1. Run `npm run watch` to run the project locally. Should be accessible at `localhost:8000`
|
||||
2. 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.
|
||||
|
||||
@@ -28,10 +27,10 @@ You can use [Docker](https://docs.docker.com) to get up and running with Natural
|
||||
1. You may have to use `docker-machine env` to get the IP address of your docker instance
|
||||
|
||||
|
||||
### changelog
|
||||
### Changelog
|
||||
|
||||
You can check out the changelog [here](https://github.com/stolksdorf/homebrewery/blob/master/changelog.md)
|
||||
|
||||
### license
|
||||
### License
|
||||
|
||||
This project licensed under [MIT](./license)
|
||||
This project is licensed under [MIT](./license)
|
||||
|
||||
@@ -3,11 +3,14 @@
|
||||
"description": "Create authentic looking D&D homebrews using only markdown",
|
||||
"version": "2.3.0",
|
||||
"scripts": {
|
||||
"postinstall": "gulp prod",
|
||||
"build": "node_modules/.bin/gulp prod",
|
||||
"watch": "node_modules/.bin/gulp",
|
||||
"libs": "node_modules/.bin/gulp fresh",
|
||||
"postinstall": "npm run build",
|
||||
"start": "node server.js"
|
||||
},
|
||||
"author": "stolksdorf",
|
||||
"license": "BSD-2-Clause",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"app-module-path": "^1.0.4",
|
||||
"basic-auth": "^1.0.3",
|
||||
|
||||
Reference in New Issue
Block a user