Rails application for GTIC Home Page

Major dependencies:

Ruby version: 3.0.0
Rails version: 6.1.3
npm version: 7.21.1
Database creation: ./db/production.sqlite3 (DO NOT COMMIT in Github)

0. Preparation on server machine

a. Install Sendmail

sendmail for send email

sudo apt install sendmail -y

After installation, configure by

sudo sendmailconfig

1. Full Installation (Ruby, Rails, apache2, passenger)

a. Install Ruby

Install requirements.

sudo apt install curl
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

sudo apt-get update
sudo apt-get install git-core zlib1g-dev build-essential \
    libssl-dev libreadline-dev libyaml-dev libsqlite3-dev \
    sqlite3 libxml2-dev libxslt1-dev libcurl4-openssl-dev \
    software-properties-common libffi-dev nodejs yarn -y

Install Ruby via rvenv (RuBy ENVironment).

cd
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
exec $SHELL

git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
echo 'export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH"' >> ~/.bashrc
exec $SHELL

rbenv install 3.0.0
rbenv global 3.0.0
ruby -v

Install bundler

gem install bundler

b. Install Rails

gem install rails -v 6.1.3

rbenv rehash

rails -v
# Rails 6.1.3

c. Install apache2

sudo apt install apache2 apache2-utils -y

Edit apache2 directory config (may not need?)

sudo vim /etc/apache2/mods-enabled/dir.conf

Change as like below:

<IfModule mod_dir.c>

    DirectoryIndex index.php index.html index.cgi index.pl index.xhtml index.htm

</IfModule>

d. Install passenger (railsをapache2で使うためのプログラム)

sudo apt install libcurl4-openssl-dev apache2-threaded-dev

gem install passenger

passenger-install-apache2-module

The command passenger-install-apache2-module will take about 30 min.

If it says lack of memory. Add swap.

sudo dd if=/dev/zero of=/swap bs=1M count=1024
sudo mkswap /swap
sudo swapon /swap

Edit apache2 config

sudo vim /etc/apache2/apache2.conf

Add output of passenger-install-apache2-module like below. (attention! the path is depended on your user name!)

LoadModule passenger_module /home/your_user_name/.rbenv/versions/3.0.0/lib/ruby/gems/3.0.0/gems/passenger-6.0.7/buildout/apache2/mod_passenger.so
<IfModule mod_passenger.c>
  PassengerRoot /home/your_user_name/.rbenv/versions/3.0.0/lib/ruby/gems/3.0.0/gems/passenger-6.0.7
  PassengerDefaultRuby /home/your_user_name/.rbenv/versions/3.0.0/bin/ruby
</IfModule>

If you missed output of passenger-install-apache2-module, type passenger-install-apache2-module --snippet to output again.

e. Add gticapp config (for HTTP)

sudo vim /etc/apache2/sites-available/gticapp.conf

Add below lines.

<VirtualHost *:80>
    ServerName gtic.jp
    ServerAlias gtic.jp
    ServerAdmin webmaster@localhost

    # !!! Be sure to point DocumentRoot to 'public'!
    DocumentRoot /var/www/html/gticapp/public

    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined

    <Directory /var/www/html/gticapp/public>
        # This relaxes Apache security settings.
        AllowOverride all

        # MultiViews must be turned off.
        Options -MultiViews

        # Uncomment this if you're on Apache >= 2.4:
        # Require all granted
    </Directory>
</VirtualHost>

f. Enable HTTPS by using Let's Encrypt

Goto Let's Encrypt, followo the instuctions to enable HTTPS. It will generate new gticapp config at /etc/apache2/sites-available/gticapp-le-ssl.conf.

g. Add environment variables in config

Open gticapp ssl config

sudo vim /etc/apache2/sites-available/gticapp-le-ssl.conf

Add variable name and values like below:

SetEnv VARIABLE_NAME some_value

h. Enable gticapp site

ポートを通す使うアプリ指定

sudo a2ensite gticapp

使わないアプリを取り除く

sudo a2dissite (gticapp以外は全部取り除く)

i. Download gticapp

cd /var/www/html
sudo git clone https://github.com/newini/gticapp.git
sudo chown your_user_name:your_user_name gticapp

j. Install gems

cd /var/www/html/gticapp
bundle install

k. Restart apache2

sudo service apache2 restart

2. Useful commands to maintain

a. bundle

Update gems on /vendor

bundle update

If you added new gems in Gemfile, use bundle install to install.

b. Database migration

b.1 Create table

bin/rails generate model Article

and add necessary columns

t.string :title
t.text :body

b.2 Add/Change/Remove column

change db: bin/rails g migration AddUserIdToPosts
open migration file in db/migrate/2021...:

class AddUserIdToPosts < ActiveRecord::Migration
  def change
    ...
  end
end

Add like belows: :table_names, :column_name, :type

add column: add_column :posts, :user_id, :integer, :default => false
change column: change_column :posts, :admin, :boolean, :default => false
remove column: remove_column :posts, :place, :string

To rename column name, do this

rename column: rename_column :table_names, :old_column, :new_column

implement: bin/rake RAILS_ENV=production db:migrate
if want to go back: rake db:rollback

c. SQLITE3

List tables: .tables
View all in a table: select * from members;
View column names in a table: pragma table_info(members);
Search in a table: select * from members where last_name='...'and first_name='...';
Update a column in a table: update members set gtic_flg='t' where last_name='...'and first_name='...';
Delete a row in a table: DELETE FROM users WHERE id=;

d. Yarn (js module manager) (Not use anymore)

d.1 Install yarn modules

The yarn module is on package.json. ex. "aos": "^2.3.4". To install these modules, type as below command.

yarn install

d.2 Add new yarn modules

If you want to add new js module, type

yarn add module_name

and edit app/javascript/packs/application.js and app/assets/stylesheets/application.scss.

e. npm (module manager)

e.0 Install latest npm

Add local npm path

cd
mkdir -p .npm
npm config set prefix ~/.npm

Next, Install latest npm

npm install -g npm@latest

Then, add below line into .zshrc or .bashrc to load local npm path.

export PATH="$HOME/.npm/bin:$PATH"

Restart the terminal and check npm version

npm --version
# 7.21.1

e.1 Install modules by npm

The modules are defined in package-lock.json.

npm ci

e.2 Add new npm module

npm install module_name

f. Edit credentials

bin/rails credentials:edit

and edit app/javascript/packs/application.js and app/assets/stylesheets/application.scss.

g. Compile

g.1 webpack for JavaScript

There two targets

app/javascript/packs/application.js
app/javascript/packs/admin.js

For development mode, webpack compile automatically.

For production mode, use below command to compile manually.

bin/webpack --profile

g.2 compile for scss files

There is one target

app/assets/stylesheets/application.scss

bundle exec rake assets:clean

bundle exec rake assets:clobber
#bundle exec rake assets:clobber RAILS_ENV=production

bundle exec rake assets:precompile
#bundle exec rake assets:precompile RAILS_ENV=production

3. about CSS and JS

Installed CSS

bootstrap 5
hover.css: mouse hover effects. See documents and examples. How to install hover.css
font-awesome: font icons doc

Installed JS

@rails/ujs
turbolinks
jquery
popper.js
aos: Animate On Scroll Library. Documents
chartkick: Create beautiful JavaScript charts with one line of Ruby
chart.js: js for chartkick
plotly.js: graphing libraries

Useful links

css color keywords

4. Some codes

a. Merge the same-name members

This keep older-member and delete newer-members. Of course, update all newer-members' id in BroadcastMember, MediaArticle, Presentation, Staff, Presentationship, Relationship.

members = Member.where.not(last_name: [nil, ""], first_name: [nil, ""])
members.each do |member|
  duplicated_members = Member.where(last_name: member.last_name, first_name: member.first_name)
  if duplicated_members.count >= 2
    old_member = duplicated_members[0]
    duplicated_members.each_with_index do |duplicated_member, index|
      if index >= 1
        BroadcastMember.where(member_id: duplicated_member.id).update_all(member_id: old_member.id)
        MediaArticle.where(member_id: duplicated_member.id).update_all(member_id: old_member.id)
        Presentation.where(member_id: duplicated_member.id).update_all(member_id: old_member.id)
        Staff.where(member_id: duplicated_member.id).update_all(member_id: old_member.id)

        # Treats unique member_id and event_id
        pres = Presentationship.where(member_id: duplicated_member.id)
        pres.each do |pre|
          if not Presentation.where(member_id: old_member.id, event_id: pre.event_id)[0]
            pre.update(member_id: old_member.id)
          end
        end

        res = Relationship.where(member_id: duplicated_member.id)
        res.each do |re|
          if not Relationship.where(member_id: old_member.id, event_id: re.event_id)[0]
            re.update(member_id: old_member.id)
          end
        end

        duplicated_member.destroy
      end
    end
  end
end

b. Delete FB info only members.

This delele members, which don't have first_name and last_name, and didn't attended any events.

members = Member.where(last_name: [nil, ""], first_name: [nil, ""])
members.each do |member|
  if member.participated_events.count == 0
    BroadcastMember.where(member_id: member.id).destroy_all
    MediaArticle.where(member_id: member.id).destroy_all
    Presentation.where(member_id: member.id).destroy_all
    Presentationship.where(member_id: member.id).destroy_all
    Relationship.where(member_id: member.id).destroy_all

    member.destroy
  end
end

Trouble shooter

problem

libffi.so.7: cannot open shared object file: No such file or directory

solution:

sudo apt install libffi7

TODO

translate static pages and put to config/locale/.
connect with GOOGLE