-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ci skip]Add Kajaeru's usage on production
- Loading branch information
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,6 +5,43 @@ Kajaeru is a web-based voting application to elect Ruby Kaja. ( "eru(選る)" is | |
|
||
About Ruby Kaja, see the [web page](http://kaja.rubyist.net/) for more information. | ||
|
||
## Usage | ||
|
||
Kajaeru runs on heroku. | ||
|
||
``` | ||
# clone this repository | ||
git clone [email protected]:yochiyochirb/kajaeru.git | ||
cd kajaeru | ||
# create heroku app for kajaeru | ||
heroku create | ||
git push heroku master | ||
# run migration | ||
heroku run rake db:migrate | ||
# set environment variable | ||
heroku config:set GITHUB_CLIENT_ID=XXXXX | ||
heroku config:set GITHUB_CLIENT_SECRET=XXXXX | ||
# open browser | ||
heroku open | ||
``` | ||
|
||
Before using Kajaeru you need to register Kajaeru, that is an OAuth application, in [GitHub Account Settings Menu](https://github.com/settings/developers). | ||
|
||
At the "Register a new OAuth application" window, type the texts below: | ||
|
||
- Application name | ||
- Kajaeru (or other name you can recognize) | ||
- Homepage URL | ||
- URL of your application | ||
- Description | ||
- A voting application for Ruby Kaja | ||
- Authorization callback URL | ||
- #{your_applicaton_url}/auth/github/callback | ||
|
||
## Development | ||
|
||
### Setup | ||
|