Skip to content

Documentation update and pre-commit hook #1

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

Merged
merged 5 commits into from
Jun 6, 2017
Merged

Documentation update and pre-commit hook #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bca2e27
Documentation update and precommit hook
Jun 6, 2017
57996b3
Moved markdown related packages to devDependencies
Jun 6, 2017
4c64aee
Added repository field in package.json
Jun 6, 2017
b458252
Fixed ENV Vars for secret key and audience
Jun 6, 2017
fb9f190
Adding index.html to git before commit
Jun 6, 2017
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
19 changes: 11 additions & 8 deletions README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ $ npm install -g create-staffbase-plugin
$ create-staffbase-plugin /home/user1/work/staffbase-server/ --name staffbase-sso-server
```

You can use `yarn create` to directly run the command
You can use `yarn create` to directly run the command. The syntax of `yarn create staffbase-plugin` is:
> yarn create staffbase-plugin [Destination folder] --name [Plugin Name]

Example:
```bash
$ yarn create create-staffbase-plugin /home/user1/work/staffbase-server/ --name staffbase-sso-server
$ yarn create staffbase-plugin /home/user1/work/staffbase-server/ --name staffbase-sso-server
```
## Interactive Mode
You can also run the command without passing any arguments to get into interactive
Expand All @@ -33,7 +36,7 @@ On entering the path, you can either specify an absolute path or a relative path
After the scaffolding is complete, you need to provide some values for configuring your
plugin server. The following values need to be configured.

- Plugin Secret Key
- Plugin Secret
- Plugin Audience

You can either specify these values in environment variables or directly passing
Expand All @@ -45,8 +48,8 @@ app.js
```javascript
12 ...
13 ...
14 const staffbaseKey = null;
15 const plguinID = null;
14 const key = null;
15 const pluginID = null;
16 ...
```

Expand All @@ -55,12 +58,12 @@ Refer to the table to see which environment variables can be used.

| *Value* | *Environment Variable* |
|:------------|:--------------------------: |
|Plugin Secret|STAFFBASE_SSO_SECRET |
|Plugin ID |STAFFBASE_SSO_AUDIENCE |
|Secret |STAFFBASE_SSO_SECRET |
|Audience |STAFFBASE_SSO_AUDIENCE |
|Server Port |PORT |

## Running the server
_create-staffbase-sso-server_ installs the project dependencies for you.
_create-staffbase-plugin_ installs the project dependencies for you.
After configurations is done, the only thing you need to do is navigate to the
folder where your app was generated and start the express server.
```bash
Expand Down
Loading