Commit 1dad113f by tady

fix readme text

parent 2359ad14
...@@ -2,8 +2,8 @@ ...@@ -2,8 +2,8 @@
# SET YOUR ENV HERE. # SET YOUR ENV HERE.
export GOOGLE_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com" export GOOGLE_CLIENT_ID="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com"
export GOOGLE_SECRET="xxxxxxxxxxxxxxxxxxxxxxxx" export GOOGLE_CLIENT_SECRET="xxxxxxxxxxxxxxxxxxxxxxxx"
export DB_TEST_USER="user" export DB_TEST_USER="user"
export DB_TEST_PASS="pass" export DB_TEST_PASS="pass"
export DB_DEVELOPMENT_USER="user" export DB_DEVELOPMENT_USER="user"
......
rendezvous rendezvous
==========
A simple markdown-based wiki system for term. ==========
## Badge
[![Build Status](https://travis-ci.org/tadyjp/rendezvous.png)](https://travis-ci.org/tadyjp/rendezvous) [![Build Status](https://travis-ci.org/tadyjp/rendezvous.png)](https://travis-ci.org/tadyjp/rendezvous)
[![Coverage Status](https://coveralls.io/repos/tadyjp/rendezvous/badge.png)](https://coveralls.io/r/tadyjp/rendezvous) [![Coverage Status](https://coveralls.io/repos/tadyjp/rendezvous/badge.png)](https://coveralls.io/r/tadyjp/rendezvous)
[![Code Climate](https://codeclimate.com/github/tadyjp/rendezvous.png)](https://codeclimate.com/github/tadyjp/rendezvous) [![Code Climate](https://codeclimate.com/github/tadyjp/rendezvous.png)](https://codeclimate.com/github/tadyjp/rendezvous)
[![Dependency Status](https://gemnasium.com/tadyjp/rendezvous.png)](https://gemnasium.com/tadyjp/rendezvous) [![Dependency Status](https://gemnasium.com/tadyjp/rendezvous.png)](https://gemnasium.com/tadyjp/rendezvous)
A simple markdown-based wiki system for team.
# Supported versions
- Ruby 2.0.0+
- Rails 4.0.0+
# How to install and use. # How to install and use.
Get code and install gems. Get code and install gems.
...@@ -19,25 +25,42 @@ $ cd rendezvous ...@@ -19,25 +25,42 @@ $ cd rendezvous
$ bundle install $ bundle install
``` ```
Create YOUR .ENV file. Get Google API Key.
Register application on https://code.google.com/apis/console,
and get
1. Access https://code.google.com/apis/console
2. Create New Project
3. Create Client ID ([APIs & auth] > [Credentials] > [CREATE NEW CLIENT ID])
4. Enter
- `http://localhost:3000` in [Authorized Javascript origins]
- `http://localhost:3000/users/auth/google_oauth2/callback` in [Authorized redirect URI]
and save
5. Get [Client ID] and [Client secret]
Create your .env file.
``` ```
$ cp .env.example .env $ cp .env.example .env
$ vim .env $ vim .env
``` ```
Set Google API [Client ID] and [Client secret] in `.env`
Setup DB (Default: mysql). Setup DB (Default: mysql).
``` ```
$ bundle exec rake db:migrate $ (bundle exec) rake db:migrate
$ bundle exec rake db:seed $ (bundle exec) rake db:seed
``` ```
Set ENV before start server. Set ENV before start server.
``` ```
$ source .env $ source .env
$ bundle exec rails s $ (bundle exec) rails s
``` ```
And have fun with your team ! And have fun with your team !
Rails.application.config.middleware.use OmniAuth::Builder do Rails.application.config.middleware.use OmniAuth::Builder do
provider :google_oauth2, ENV['GOOGLE_KEY'], ENV['GOOGLE_SECRET'], provider :google_oauth2, ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET'],
name: 'google_oauth2', name: 'google_oauth2',
scope: 'https://mail.google.com/, userinfo.email, userinfo.profile', scope: 'https://mail.google.com/, userinfo.email, userinfo.profile',
access_type: 'offline', access_type: 'offline',
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment