fengarix / Agreement-Integration-Platform

Super secret project initiated by a team of scrum experts

Agreement Integration Platform¶ ↑

By PPL Veritrans “TheATeam”¶ ↑

Aplikasi ini berhasil dijalankan di Ruby versi 2.3.

Installation Instructions (Development)¶ ↑

1. Pasang RVM, Ruby 2.3, dan Ruby on Rails di environment Anda. Sangat disarankan menggunakan UNIX (OS X atau Linux).

2. Clone repository ini.

3. Jalankan rake db:migrate dan rake db:seed di Terminal.

4. Jalankan server WEBrick dengan menjalankan perintah bin/rails server di Terminal.

Standarisasi Penyesuaian dengan Branch master¶ ↑

1. Pastikan versi Ruby yang ter-install RVM adalah versi 2.3. Jika belum, maka jalankan rvm install 2.3, rvm use 2.3 --default, dan gem install rails

2. Untuk OS X, install Homebrew dan Postgres.app, kemudian jalankan brew install postgresql. Untuk Ubuntu, jalankan sudo apt-get install postgresql-9.4

3. Jalankan gem install pg

4. Buat role baru di PostgreSQL. Jalankan server PostgreSQL, masuklah ke command line client PostgreSQL, kemudian jalankan create role aip with createdb login password 'cendikiawan';

5. Jalankan bundle install untuk meng-install segala dependency yang diperlukan. Apabila semua telah berhasil, jalankan rake db:setup

Code Conventions¶ ↑

Berikut merupakan code conventions penting yang diterapkan:

• Model menggunakan kata benda singular, sementara nama tabel plural.

• Nama kelas menggunakan CamelCase, sementara variabel dan database (baik nama tabel maupun atributnya) menggunakan snake_case.

• Indentasi menggunakan 2 spasi per tingkat (sesuai standar Ruby).

• Gunakan single quotes untuk string kecuali jika Anda ingin melakukan interpolation. Hal ini semata hanya untuk mengurangi visual clutter.

• Gunakan parentheses (tanda kurung) untuk penggunaan variabel dan method kecuali untuk internal domain specific language (seperti Rake, Rails, RSpec), method yang menggunakan keyword status di Ruby (seperti attr_reader, puts) dan method untuk mengakses atribut. Penjelasan lebih lanjut bisa dilihat di sini.

• Pastikan tidak ada trailing whitespace di akhir baris dan baris kosong. Gunakan package seperti TrailingSpaces untuk Sublime Text atau Atom whitespace package untuk memudahkan Anda.

• Buat sebuah newline kosong di akhir semua file.

• Perhatikan vertical indentation agar kodenya lebih enak dibaca. Kita tidak akan menggunakan standar tertentu, yang penting jangan ragu-ragu untuk menggunakannya.

Daftar selengkapnya bisa dilihat di sini.

To-do¶ ↑

Hal yang perlu dilakukan ke depannya untuk dokumentasi ini:

• Cara menjalankan test suite

• Services yang digunakan (job queues, cache servers, search engines, dll)