Skip to content

Update README.md #117

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 1 commit into from
Jul 24, 2014
Merged

Update README.md #117

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
28 changes: 17 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,23 @@ bundle exec rake db:create
bundle exec rake db:migrate db:test:prepare
```

### Enable GitHub authentication

Create an application at `https://github.com/settings/applications/new` with
`http://localhost:3000` as the `Homepage URL` and `http://localhost:3000/auth/github`
as the `Authorization callback URL`.

Once your development application is setup, create a file named `.env` in the root of the
application folder with the GitHub key and secret like so:

GITHUB_KEY=YOUR_KEY
GITHUB_SECRET=YOUR_SECRET

Note: windows doesn't like creating a file named .env so do the following from a cmd prompt in your application folder:

echo GITHUB_KEY=YOUR_KEY >> .env
echo GITHUB_SECRET=YOUR_SECRET >> .env

### Generate some data!

```bash
Expand All @@ -53,17 +70,6 @@ bundle exec rake db:seed
bundle exec rake
```

### Enable GitHub authentication

Create an application at `https://github.com/settings/applications/new` with
`http://localhost:3000` as the `Homepage URL` and `http://localhost:3000/auth/github`
as the `Authorization callback URL`.

Once you development application is setup, create a file named `.env` in the root of the
application folder with the GitHub key and secret like so:

GITHUB_KEY=YOUR_KEY
GITHUB_SECRET=YOUR_SECRET

### Find something to work on
You can pick one of the open [issues](https://github.com/codebar/planner/issues), fix a bug, improve the interface, refactor the code or improve test coverage!
Expand Down