README

   1 ================================================================================
   2    エレコマ(Elephant Commerce)                          http://ec.appirits.com/
   3 ================================================================================
   4
   5 エレコマのダウンロードありがとうございます。
   6 エレコマは、Ruby on Railsで開発したECommerceシステムです。
   7 オープンソースとして、MIT Licenseを採用しています。
   8
   9 このREADMEでは、エレコマを稼動させるまでの必要最低限の手順を記載しています。
  10
  11 ================================================================================
  12   エレコマ 動作環境
  13 ================================================================================
  14 エレコマを動かすに辺り、以下の環境を奨励します。
  15 （下記環境以外でも動作する可能性はあります）
  16
  17  - OS    : CentOS 6.4
  18  - DB    : postgresql 8.4系
  19  - Ruby  : 1.9.3
  20  - Rails : 2.3.17
  21
  22 ================================================================================
  23   エレコマ 依存plugin
  24 ================================================================================
  25 エレコマではpluginの一部を含めて配布しています。
  26 以下のpluginが同梱されています。
  27
  28
  29 active-form
  30   git://github.com/realityforge/rails-active-form.git
  31   rev: f1e74bec3d87c23cfc05ca7df11925c08e55514f
  32
  33 acts_as_paranoid
  34   git://github.com/technoweenie/acts_as_paranoid.git
  35   rev: b0a5d2b8ba89eae03f673e4af2e52619260fcc30
  36
  37 mbmail
  38   git://github.com/tmtysk/mbmail.git
  39   rev: 654ce3ec2dfa10ac3b05cd9354eb84456d206a6d
  40
  41 ssl_requirement
  42   git://github.com/rails/ssl_requirement.git
  43   rev: 34a9a138c4093bd7d5678822f8f1e62c31d47299
  44
  45 double_submit_protection
  46   git://github.com/DianthuDia/double_submit_protection.git
  47   rev: 7fc2e629b9fccb1736be7ea9da63e578f835a307
  48
  49 image_submit_tag_ext
  50   git://github.com/champierre/image_submit_tag_ext.git
  51   rev: 572ce5ce5d40ee1494ddd0a121483e8791bb2184
  52
  53 ================================================================================
  54   エレコマ インストール手順
  55 ================================================================================
  56 CentOS 6.4でのインストールを想定しています。
  57  前提条件は以下となります。
  58  -CentOS 6.4 minimal をインストール済み
  59
  60 1. rubyのインストール
  61 # yum -y groupinstall "Base" "Development tools"
  62 # yum -y install zlib-devel
  63 # yum -y install openssl-devel
  64 # yum -y install ncurses-devel
  65 # yum -y install readline-devel
  66 # wget ftp://ftp.ruby-lang.org/pub/ruby/1.9/ruby-1.9.3-p194.tar.gz
  67 # tar zxf ruby-1.9.3-p194.tar.gz
  68 # cd ruby-1.9.3-p194
  69 # ./configure
  70 # make
  71 # make install
  72
  73 2. gemのインストール
  74 # wget http://rubyforge.org/frs/download.php/76032/rubygems-1.8.23.tgz
  75 # tar zxf rubygems-1.8.23.tgz
  76 # cd rubygems-1.8.23
  77 # ruby setup.rb
  78
  79 3. ImageMagickのインストール
  80 # yum -y install libjpeg-devel libpng-devel gd-devel freetype-devel
  81 # wget http://ftp.nl.netbsd.org/pub/pub/ImageMagick/ImageMagick-6.8.1-7.tar.gz
  82 # tar zxf ImageMagick-6.8.1-7.tar.gz
  83 # cd ImageMagick-6.8.1-7
  84 # ./configure --disable-openmp
  85 # make
  86 # make install
  87
  88 4. PostgreSQLのインストール
  89 # yum -y install postgresql84-devel postgresql84-server
  90
  91 5. PostgreSQLのセットアップ
  92 # /etc/init.d/postgresql initdb
  93 # vim /var/lib/pgsql/data/pg_hba.conf
  94 (TYPEが「host」のCIDR-ADDRESSが「127.0.0.1/32」となっている行の、METHODを「md5」(*1) に設定します)
  95 (*1 うまく動作しない場合は、ここを「trust」にしてみてください)
  96 # /etc/init.d/postgresql start
  97 # su - postgres
  98 $ createuser ec
  99 Shall the new role be a superuser? (y/n) y
 100 $ psql template1
 101 # alter user ec with password 'elephant';
 102 # \q
 103
 104 6. ecユーザの作成
 105 # adduser ec
 106 # passwd ec
 107 (パスワード変更)
 108
 109 7. エレコマの展開
 110 # cd /usr/local
 111 # git clone git://github.com/elecoma/elecoma.git ec
 112 # chown -R ec:ec /usr/local/ec
 113
 114 6. 依存するgemのインストール
 115 # su - ec
 116 $ cd /usr/local/ec
 117 $ bundle install --path vendor/bundle
 118
 119 7. 開発向けセットアップ
 120 $ cd /usr/local/ec
 121 $ cd config
 122 $ cp database.example.yml database.yml
 123 $ vim database.yml
 124 $ diff database.example.yml database.yml
 125 3,4c3,4
 126 <   username: postgres
 127 <   password:
 128 ---
 129 >   username: ec
 130 >   password: elephant
 131 $ cd environments
 132 $ vim development.rb
 133 (メールサーバの設定を変更)
 134 $ vim production.rb
 135 (メールサーバの設定を変更)
 136 $ vim test.rb
 137 (メールサーバの設定を変更)
 138
 139 8. Passengerのインストール
 140 # yum -y install gcc-c++
 141 # yum -y install httpd-devel
 142 # yum -y install curl-devel
 143 # gem install passenger
 144 # passenger-install-apache2-module
 145
 146 9. Apacheの設定
 147 # vim /etc/httpd/conf.d/ec.conf
 148 LoadModule passenger_module /usr/local/lib/ruby/gems/1.9.1/gems/passenger-4.0.5/ext/apache2/mod_passenger.so
 149 PassengerRoot /usr/local/lib/ruby/gems/1.9.1/gems/passenger-4.0.5
 150 PassengerRuby /usr/local/bin/ruby
 151
 152 <VirtualHost *:80>
 153   ServerName ec.example.com
 154   DocumentRoot /usr/local/ec/public
 155   RailsEnv production
 156   <Directory /usr/local/ec/public>
 157     AllowOverride all
 158     Options -MultiViews
 159   </Directory>
 160 </VirtualHost>
 161
 162 10. production環境のDB作成
 163 # su - ec
 164 $ rake db:create db:migrate RAILS_ENV=production
 165
 166 16. Apacheの再起動
 167 $ sudo /etc/init.d/httpd restart
 168
 169 17. メールマガジン用プロセスを起動
 170 $ bundle exec ruby lib/daemons/mail.rb -e production start
 171
 172 ※WEBrickでの起動も可能です。
 173 $ bundle exec ruby script/server -e production
 174
 175
 176
 177 ================================================================================
 178 * エレコマの管理者ユーザー追加
 179 ================================================================================
 180 エレコマを起動した直後は管理者ユーザーが存在しません。
 181 ユーザー登録は、RAILS_ROOT/test/fixtures/admin_users.yml の5，6，8行目を任意のものに修正した後、
 182 コンソールから以下のようにデータを登録します。
 183
 184 $ rake db:fixtures:load FIXTURES=admin_users RAILS_ENV=production
 185
 186 ユーザーを登録した後、管理画面：http://サイトドメイン/adminにアクセスすると、
 187 ログイン画面が表示されますので、RAILS_ROOT/test/fixtures/admin_users.ymlで指定した
 188 登録したログインIDとパスワードでログインしてください。
 189 なお、初期状態ではSHOPマスタの情報が入っておりませんので、
 190 SHOPマスタ登録にて初期情報を入力してください。
 191
 192 ================================================================================
 193 * SSLの切り替え
 194 ================================================================================
 195 エレコマではSSLの設定をデータベースに保存しています。
 196 そのため、万が一管理画面にアクセスできなくなった場合は、
 197 以下のようにして手動で切替えてください。
 198
 199 $ script/console production
 200 >> system = System.first
 201 >> system.use_ssl = false
 202 >> system.save
 203
 204 use_sslの値はtrueの時にSSLを利用し、falseの時にSSLを利用しなくなります。
 205
 206 ================================================================================
 207 * エレコマの住所マスタ更新
 208 ================================================================================
 209 エレコマの住所マスタは郵便事業株式会社の郵便番号マスタを利用しています。
 210 登録はコンソールから以下のように行ないます。
 211
 212 $ ruby script/runner -e production Zip.import
 213
 214 郵便番号マスタは以下のサイトにて配布されているものを自動的に取り込みます。
 215 http://www.post.japanpost.jp/zipcode/download.html
 216
 217 住所マスタ更新機能はLhaLibに依存しています。
 218 LhaLibの詳細については以下のサイトをご確認ください。
 219 http://www.artonx.org/collabo/backyard/?LhaLibEn
 220
 221
 222 ================================================================================
 223 * エレコマの商品追加
 224 ================================================================================
 225 エレコマを起動した直後は商品が存在していません。
 226 管理画面から、商品の追加を行う必要があります。
 227
 228 1. 管理者ユーザーでログインする
 229 --------------------------------------------------------------------------------
 230
 231 2. 商品の登録
 232 --------------------------------------------------------------------------------
 233 商品登録には、カテゴリ、規格、在庫の設定が必要となります。
 234 >> カテゴリの登録
 235  - 管理画面の商品管理 -> カテゴリ管理 よりカテゴリを登録する
 236
 237 >> 規格の管理
 238  - 管理画面の商品管理 -> 規格管理 より規格を登録する
 239
 240 >> 商品の登録
 241 >>>> 1つずつ登録する場合
 242  - 管理画面の商品管理 -> 商品登録 より商品の登録を行う
 243
 244 >>>> CSVで一括登録する場合
 245  - 管理画面の商品管理 -> 商品マスタ -> CSVアップロード から アップロードする
 246
 247 商品登録後、商品の規格を設定します。
 248 >> 商品規格の登録
 249  1. 商品登録完了画面もしくは商品マスタの商品一覧 -> 規格登録 から規格を選択し「表示する」ボタンを押下する
 250  2. 規格リストが表示されるので、必要な規格の登録項目にチェックを入れ、商品コード、価格を入力し、登録を行う
 251
 252 >> 在庫の登録
 253  - 管理画面の発注・出荷管理 -> 在庫管理 より対象商品の在庫数を登録する
 254
 255 以上で、商品がフロント画面に表示されるようになります
 256
 257
 258
 259 ================================================================================
 260 * ユニットテスト
 261 ================================================================================
 262 エレコマではユニットテストにRspecを利用しています。
 263 利用するには、以下のようにコマンドを実行してください。
 264
 265 rspecの実行
 266 --------------------------------------------------------------------------------
 267 $ ruby script/spec spec
 268 このコマンドを発行するとユニットテストが実行されます。
 269
 270
 271 ================================================================================
 272 * エレコマ ライセンス
 273 ================================================================================
 274 本ソフトウェアはMIT Licenceを採用しています。
 275 ライセンスの詳細についてはCOPYRIGHTファイルを参照してください。
 276
 277 配布物に含まれる「エレコマ」のロゴはクリエイティブ・コモンズノ表示-継承 2.1
 278 日本ライセンスに従った範囲内でご利用いただけます。
 279
 280
 281 ================================================================================
 282 * 配布物に含まれる別プロジェクトのファイル
 283 ================================================================================
 284 1. さざなみフォント
 285 配布物に含まれる以下のファイルはさざなみフォントを利用しています。
 286 lib/sazanami-gothic.ttf
 287 さざなみフォントは以下のライセンスに基づきます。
 288
 289 Copyright (c) 1990-2003
 290         Wada Laboratory, the University of Tokyo. All rights reserved.
 291 Copyright (c) 2003-2004
 292         Electronic Font Open Laboratory (/efont/). All rights reserved.
 293
 294 Redistribution and use in source and binary forms, with or without
 295 modification, are permitted provided that the following conditions
 296 are met:
 297 1. Redistributions of source code must retain the above copyright notice,
 298    this list of conditions and the following disclaimer.
 299 2. Redistributions in binary form must reproduce the above copyright notice,
 300    this list of conditions and the following disclaimer in the documentation
 301    and/or other materials provided with the distribution.
 302 3. Neither the name of the Wada Laboratory, the University of Tokyo nor
 303    the names of its contributors may be used to endorse or promote products
 304    derived from this software without specific prior written permission.
 305
 306 THIS SOFTWARE IS PROVIDED BY WADA LABORATORY, THE UNIVERSITY OF TOKYO AND
 307 CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
 308 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 309 PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE LABORATORY OR
 310 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 311 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 312 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 313 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 314 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 315 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 316 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.