Lodge

これは何？

ロッジと呼びます。 __イントラネット限定でも使える、ナレッジ/ノウハウ情報共有サービス__です。手軽に導入できて、チーム内全体の情報共有やナレッジ蓄積の手助けができることを目標としています。

主な特徴

以下のような特徴を持ちます。

無料、OSS、MIT License
イントラネット内での構築が可能なので、社外秘な情報を含むナレッジやノウハウの共有に利用可能。
Markdown記法による直感的かつ簡単な記述でサクサク書ける
コードのシンタックスハイライト機能
投稿前に確認できるプレビュー機能
ストック機能により、お気に入りの記事やあとで見たい記事等を手軽に保存
記事に複数のタグをつけて管理
タグをフォローすることによる個人ごとのフィードのカスタマイズ表示
記事タイトルによる簡単な検索
導入までの手軽さ(すぐにインストールできます)
コメント、Contribution、通知機能等によるコミュニケーションやナレッジ共有活動の活性化
編集履歴機能により記事の変更点を差分表示
メールアドレスだけで誰でも簡単にアカウント作成が可能
Gravatarと連携したユーザアイコン(登録メールアドレスから自動取得)

上記以外にもまだまだ新機能開発や改善を行っていく予定です。皆様のご協力をお願い致します。

スクリーンショット

一覧画面

記事閲覧画面

デモ

以下のURLから、実際に体験できます。

http://lodge-sample.herokuapp.com/

お試し用のユーザ名は以下、パスワードは全て password でログインできます。

user01@example.com
user02@example.com
user03@example.com
user04@example.com
user05@example.com

また、新規ユーザ登録もメールアドレスから行えます。

※但し、上記サイトは自体はpublicなので、ご登録の際にはご注意ください。

インストール

事前準備として以下が必要ですので、インストールしておきます。
- Ruby 1.9以上
- Gem 2.2以上
- MySQL (MySQLを利用する場合)
- sqlite3 (sqlite3を利用する場合)
まずは本プロジェクトをcloneしてきます。
```
git clone https://github.com/m-yamashita/lodge.git
```

config/database.example.yml を config/database.yml としてコピーし、以下のように編集します(SQLite3もしくはMySQLをご利用になる場合はコメントアウトを外して設定すると楽です)。

default: &default
#  # === sqlite3 ===
#  adapter: sqlite3
#  encoding: utf8
#  pool: 5

  # === mysql ===
  adapter: mysql2
  host: localhost
  username: your_mysql_user_name
  password: your_mysql_password
  encoding: utf8
  pool: 5

bundle install を実行します。
rake db:create RAILS_ENV=production の後、 rake db:migrate RAILS_ENV=production を実行します。これでDBは完成です。

config/environments/production.example.rb を config/environments/production.rb としてコピーし、ファイル最下部にある以下の部分を編集します。各コメントを参考に設定してください。

# Devise Settings
# 以下は主にユーザ登録やパスワード忘れの際のメール送信で利用する設定です。
# メールに記載する本サービスのURL
config.action_mailer.default_url_options = { :host => 'localhost:3000' }
# SMTPの指定
config.action_mailer.delivery_method = :smtp
config.action_mailer.smtp_settings = {
  :address => "smtp.gmail.com", # SMTPサーバ
  :port => 587, # ポート
  :domain => 'gmail.com', # gmail.com以外のドメイン名の場合はそれに合わせて変更してください。
  :user_name => "", # ユーザ名
  :password => "", # パスワード
  :authentication => 'plain', # 認証方式
  :enable_starttls_auto => true,
}

productionモードで動かす為には、secret_keyを設定します(developmentモードでは必要ありません)。これは実行する環境の環境変数に設定しますので、~/.bashrc 等に書いておくと便利です。

bashの場合

echo "export SECRET_KEY_BASE=\"`rake secret`\"" >> ~/.bashrc; source ~/.bashrc

zshの場合

echo "export SECRET_KEY_BASE=\"`rake secret`\"" >> ~/.zshrc; source ~/.zshrc

起動

rails server -e production を叩けばOKです。サーバが立ち上がり、Lodgeが利用できるようになります。

※Apache+Passengerや、nginx+Unicorn等でも起動できますので、より高速に動かしたい場合等はそちらをオススメします(設定方法等は割愛)。

最後に

開発にご協力頂ける方を募集しています。

まだまだ拙いLodgeの開発を手助けしていただける方を大募集中です。新機能の開発や改善はもちろん、ソースのリファクタリングからテストの記述、果てはマニュアル改善まで、どうぞ遠慮無くpull request頂ければと思います。

kimihito / lodge