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

Jump to bottom

Update documentation #237

Merged
merged 5 commits into from
Oct 14, 2019
Merged

Update documentation #237

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7efe903
Merge pull request #1 from opencollective/master
DuaneOBrien Oct 5, 2019
d47c7d2
making minor improvements to the installation documentaion
DuaneOBrien Oct 5, 2019
fa1ec02
fixing capitilization in reference to the LICENSE file
DuaneOBrien Oct 5, 2019
1b9c4c2
clarifies that BYS is accessed over localhost:3000 after running npm …
DuaneOBrien Oct 5, 2019
6074b47
updates README to clarify how GitHub API keys are used
DuaneOBrien Oct 6, 2019
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: 2 additions & 0 deletions .env.template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
GITHUB_CLIENT_ID = ""
GITHUB_CLIENT_SECRET = ""
30 changes: 20 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,17 @@ The official BackYourStack service is available from https://backyourstack.com/

## Development

Make sure you have Node.js version >= 10. We recommend using [nvm](https://github.com/creationix/nvm): `nvm install`.
### Prerequisites

#### Node.js

Make sure you have Node.js version >= 10. We recommend using [nvm](https://github.com/creationix/nvm): `nvm install`

#### GitHub API Keys

To allow authentication with GitHub, you'll need a set of keys for the GitHub API. You can get these keys by [registering a new OAuth application with GitHub](https://github.com/settings/applications/new). By default, the callback URL should be `http://localhost:3000/auth/github/callback`.

You will need the Client ID and Client Secret provided by GitHub after you register your application.

### Install

Expand All @@ -31,19 +41,15 @@ cd backyourstack
npm install
```

### Start
### Store Your GitHub API Keys

`npm run dev`
We use [dotenv](https://github.com/motdotla/dotenv) to store environment variables. In the root directory of the repository, rename `.env.template` to `.env` and add the Client ID and Client Secret generated when you registerd your GitHub application.

### Environment Keys

In development environment, we use [dotenv](https://github.com/motdotla/dotenv) to set environment keys. To use it, create an `.env` file at the root of the repository and add environment keys in there.

#### GitHub API Keys
### Start

To allow authentication with GitHub, you'll need to set GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET.
`npm run dev`

You can get these keys by [registering a new oAuth application at GitHub](https://github.com/settings/applications/new). By default, the callback URL should be `http://localhost:3000/auth/github/callback`.
This will start your local copy of Back Your Stack. You can access it at `http://localhost:3000/`

## Production

Expand Down Expand Up @@ -82,3 +88,7 @@ First:
If everything is ok, finalize with:

`now alias`

## License

Back Your Stack is made available under the [MIT License](LICENSE)