================================================================================
=  SKIP version 1.1.0                              http://www.openskip.org/    =
================================================================================

SKIPのダウンロードありがとうございます。
SKIPは、コミュニケーションをベースにした情報共有を実現するアプリケーションです。
オープンソースとして、"GPL ver.3"を採用しています。

このREAME.txtでは、SKIPを稼動させるまでの必要最低限の手順を記載しています。
この手順に従い稼動させた環境は、あくまで試用を目的としたものになります。

SKIPのセットアップや利用に関する詳細な情報は、以下のアドレスより参照ください。
  SKIPポータルサイト = http://portal.openskip.org/


================================================================================
* SKIP 動作環境
================================================================================
SKIPを動かすにあたり以下の環境で検証を行っています。
（動作を保証するものではありません、また、下記環境以外でも動作する可能性はあります）

 - OS    : Linux (kernel 2.6系)
 - DB    : MySQL 5.0系
 - Ruby  : 1.8.6, 1.8.7
 - Rails : 2.1.2


================================================================================
* SKIP セットアップ
================================================================================
下記内容に従いセットアップすることで、SKIPを動かすことができます。
前提条件は以下のようになります。

 - Ruby(1.8.6 or 1.8.7), RubyGems(1.3.0以上), MySQL(5.0系)がインストール済み。
 - 公式ページから最新版SKIPをダウンロード済み。

1. gemsのインストール
--------------------------------------------------------------------------------
    $ sudo gem install rails --version 2.1.2
    $ sudo gem install gettext --version 1.93.0
    $ sudo gem install mysql fastercsv ruby-openid json

2. SKIPのファイル解凍
--------------------------------------------------------------------------------
    $ tar xvzf skip-1.1.0.tar.gz

3. 設定ファイルの準備・編集（initial_settings.yml, database.yml, common_menus.yml）
--------------------------------------------------------------------------------
    $ cp config/initial_settings.yml.sample config/initial_settings.yml
    $ cp config/database.yml.sample config/database.yml
    $ cp config/common_menus.yml.sample config/common_menus.yml
  （config/initial_settings.yml, config/database.yml, config/common_menus.ymlを適切に編集してください）

4. データベースの作成（mysqlが起動済みであること）
--------------------------------------------------------------------------------
    $ RAILS_ENV=production rake db:create
    $ RAILS_ENV=production rake db:migrate

5. 初期管理者ユーザ登録URLの生成
--------------------------------------------------------------------------------
    $ RAILS_ENV=production ruby lib/create_new_admin_url.rb --code

6. サーバ起動（2回目以降は以下のコマンドだけでかまいません）
--------------------------------------------------------------------------------
    $ ruby ./script/server -p [initial_settings.ymlで指定したSKIP起動ポート] -e production

7. 初期管理者ユーザの作成＆利用開始
--------------------------------------------------------------------------------
    5. で表示されたURLにブラウザでアクセスして、最初の運営者となるユーザを登録する。


================================================================================
* SKIPのユーザ追加
================================================================================
SKIPを起動した直後は利用可能ユーザが存在していません。
管理画面から、利用可能ユーザの追加を行う必要があります。
管理画面には、[SKIPセットアップの7.]で作成した初期管理者ユーザでログインするとアクセスできます。
（上部メニューの一番右の[設定・管理]をクリック）

1. 運営者でログインする（はじめての場合セットアップ時に作成したユーザが運営者です）
--------------------------------------------------------------------------------

2. 利用可能ユーザの登録
--------------------------------------------------------------------------------
>> 一人ずつ登録する場合
 - 設定・管理 -> データ管理 -> ユーザ -> 新規ユーザの作成 から ユーザを作成する

>> CSVで一括登録する場合
 - 設定・管理 -> データ管理 -> ユーザ -> ユーザのCSVアップロード から アップロードする

3. 利用開始のためのURLを利用可能ユーザに通知する
--------------------------------------------------------------------------------
 - 設定・管理 -> データ管理 -> ユーザ にアクセスする
 - 一覧のステータス列の[利用開始待ちにする]というリンクをクリックする
 - 一覧のステータス列ので[利用開始待ち]の右側にある[確認]というリンクをクリックする
 - 画面の指示に従って表示されたサインアップのためのURLをユーザに連絡する
 - ※詳しくはSKIP利用マニュアルを参照して下さい。

================================================================================
* ユニットテスト
================================================================================
SKIPでは、ユニットテストにRspecを利用しています。
利用するには、以下を実行してRspecのインストールを行なってください。

1. gemsのインストール
--------------------------------------------------------------------------------
    $ sudo gem install rspec
    $ sudo gem install rspec-rails

2. rspecの実行
--------------------------------------------------------------------------------
    $ rake spec
このコマンドを発行するとユニットテストが実行されます。

================================================================================
* 謝辞
================================================================================
SKIPのダウンロードありがとうございます。
改善要望や不具合を発見したなどありましたら、SKIPユーザグループにてご報告ください。
  SKIPユーザグループ = http://user.openskip.org/

* ライセンス  ・・・  GPL ver.3 (http://www.gnu.org/licenses/gpl.html)
* アイコン提供・・・  famfamfam.com (http://www.famfamfam.com/lab/icons/silk/)

================================================================================
=  お問い合わせは・・・ [email protected]                                         =
================================================================================
=  SKIP                                              http://www.openskip.org/  =
================================================================================