Add previewing docs in development guide (#843)

This commit is contained in:
Nick Holden 2018-10-11 14:02:23 -07:00 committed by Mac Siri
parent b13c09583f
commit a6ff2f3d0c
4 changed files with 1148 additions and 25 deletions

View file

@ -152,12 +152,15 @@ Secret -> STREAM_RAILS_SECRET
# Pusher
1. [Sign up for a free account with this link](https://dashboard.pusher.com/accounts/sign_up).
![screen shot 2018-10-03 at 5 48 09 pm](https://user-images.githubusercontent.com/7942714/46447013-85187700-c734-11e8-92f7-89a17240ea0f.png)
2. Once signed in, fill out the prompt to create a new Pusher Channels app. Only an app name is required.
![screen shot 2018-10-03 at 5 35 14 pm](https://user-images.githubusercontent.com/7942714/46446837-69f93780-c733-11e8-82d9-52ad97812d4b.png)
3. In your new Pusher Channels app, click the "App Keys" tab.
![screen shot 2018-10-03 at 5 41 43 pm](https://user-images.githubusercontent.com/7942714/46446905-c0667600-c733-11e8-9c55-8fabf28a27fe.png)
4. Change your keys accordingly (name of Pusher key -> name of our application key):

View file

@ -4,3 +4,7 @@ This is random collection of development hints and gotchas that we've run into i
You can modify the test in `/test/mailers/previews`
You can view the previews at (for example) `http://localhost:3000/rails/mailers/notify_mailer/new_reply_email`
## Previewing these docs in development
Run `yarn run serve-docs` and visit `http://localhost:8000` in your browser.

View file

@ -13,7 +13,8 @@
"test:watch": "jest app/javascript/ --watch",
"storybook": "start-storybook -p 6006 -c app/javascript/.storybook -s app/javascript/.storybook/assets",
"build-storybook": "build-storybook -c app/javascript/.storybook -s app/javascript/.storybook/assets",
"precommit": "lint-staged"
"precommit": "lint-staged",
"serve-docs": "cd docs && gitdocs serve"
},
"lint-staged": {
"*.{js,jsx}": [
@ -68,6 +69,7 @@
"eslint-plugin-jsx-a11y": "^6.1.2",
"eslint-plugin-react": "^7.11.1",
"faker": "^4.1.0",
"gitdocs": "^2.0.0",
"husky": "^1.1.1",
"jest": "^23.5.0",
"jest-fetch-mock": "^1.6.6",

1162
yarn.lock

File diff suppressed because it is too large Load diff