Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add setup instruction to the webiste README.md file #752

Merged
merged 1 commit into from
Dec 7, 2017
Merged

Add setup instruction to the webiste README.md file #752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
"stop-test": "forever stop ./testing/test-runners/server.js",
"docs": "jsdoc --pedantic -d dist/apidocs -r src -c jsdoc.conf.json",
"website": "cd website && npx hexo server",
"install-website": "cd website && npm install",
"setup-website": "cd website && npm install",
"build-website": "npm run build && cp -a dist/built/. website/source/built && npm run build-website-examples && npm run build-website-tutorials && npm run docs && cp -ar dist/data/. website/source/data && cp -ar dist/apidocs/. website/source/apidocs && cd website && npm install && rm -f db.json && npx hexo generate"
},
"keywords": [
Expand Down
6 changes: 5 additions & 1 deletion website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
Setup environment
=================
- Run ```npm run setup-website```

Update website
==============
- Run ```npm run build-website``` to build the website, the output will be available under ```website\public```
Expand All @@ -6,4 +10,4 @@ Update website
Develop website
===============
- Run ```npm run build-website```
- Run ```npm run website``` and navigate to ```localhost:4000```. The website will update when there is a file change.
- Run ```npm run website``` and navigate to ```localhost:4000```. The website will update when there is a file change.