Description:
merge new readme
Commit status:
[Not Reviewed]
References:
Diff options:
Comments:
0 Commit comments
0 Inline Comments
Unresolved TODOs:
There are no unresolved TODOs
Author
-
r731:2e43002166a0 - - 1 file changed: 109 inserted, 223 deleted
| @@ -1,261 +1,147 | |||||
|
|
1 | - == Welcome to Rails |
|
1 | + == Installation |
|
|
2 |
|
2 | ||
|
|
3 | - Rails is a web-application framework that includes everything needed to create |
|
3 | + Installing cafe-grader can be done in the following steps. |
|
|
4 | - database-backed web applications according to the Model-View-Control pattern. |
|
||
|
|
5 |
|
4 | ||
|
|
6 | - This pattern splits the view (also called the presentation) into "dumb" |
|
5 | + 1. Set up database. We need MySQL 5 database name, username and password. |
|
|
7 | - templates that are primarily responsible for inserting pre-built data in between |
|
6 | + 2. Install RVM. cafe-grader runs on Ruby on Rails and the best way to install it is to use RVM. |
|
|
8 | - HTML tags. The model contains the "smart" domain objects (such as Account, |
|
7 | + 3. Install necessary package for the system |
|
|
9 | - Product, Person, Post) that holds all the business logic and knows how to |
|
8 | + 4. Install cafe-grader from github |
|
|
10 | - persist themselves to a database. The controller handles the incoming requests |
|
9 | + 5. Deploy cafe-grader on apache with Phusion Passenger |
|
|
11 | - (such as Save New Account, Update Product, Show Post) by manipulating the model |
|
||
|
|
12 | - and directing data to the view. |
|
||
|
|
13 |
|
10 | ||
|
|
14 | - In Rails, the model is handled by what's called an object-relational mapping |
|
11 | + Very important!!! All commands should be run from a normal user. |
|
|
15 | - layer entitled Active Record. This layer allows you to present the data from |
|
12 | + |
|
|
16 | - database rows as objects and embellish these data objects with business logic |
|
13 | + The detail of each step are provided as follows. |
|
|
17 | - methods. You can read more about Active Record in |
|
14 | + |
|
|
18 | - link:files/vendor/rails/activerecord/README.html. |
|
15 | + === 1. Install MySQL 5 |
|
|
19 |
|
16 | ||
|
|
20 | - The controller and view are handled by the Action Pack, which handles both |
|
17 | + Install MySQL server for the server. |
|
|
21 | - layers by its two parts: Action View and Action Controller. These two layers |
|
||
|
|
22 | - are bundled in a single package due to their heavy interdependence. This is |
|
||
|
|
23 | - unlike the relationship between the Active Record and Action Pack that is much |
|
||
|
|
24 | - more separate. Each of these packages can be used independently outside of |
|
||
|
|
25 | - Rails. You can read more about Action Pack in |
|
||
|
|
26 | - link:files/vendor/rails/actionpack/README.html. |
|
||
|
|
27 |
|
18 | ||
|
|
|
19 | + cafe@grader:~$ sudo apt install mysql-server | ||
|
|
|
20 | + | ||
|
|
|
21 | + Next, we will connect to mysql as root and set up the database. You can choose your DATABASENAME, USERNAME and PASSWORD as you wish. | ||
|
|
28 |
|
22 | ||
|
|
29 | - == Getting Started |
|
23 | + cafe@grader:~$ sudo mysql -u root |
|
|
30 |
|
24 | ||
|
|
31 | - 1. At the command prompt, create a new Rails application: |
|
25 | + mysql> create database DATABASENAME; |
|
|
32 | - <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name) |
|
26 | + Query OK, 1 row affected (0.00 sec) |
|
|
33 |
|
27 | ||
|
|
34 | - 2. Change directory to <tt>myapp</tt> and start the web server: |
|
28 | + mysql> grant all privileges on DATABASENAME.* to USERNAME@localhost identified by 'PASSWORD'; |
|
|
35 | - <tt>cd myapp; rails server</tt> (run with --help for options) |
|
29 | + Query OK, 0 rows affected, 1 warning (0.00 sec) |
|
|
36 |
|
30 | ||
|
|
37 | - 3. Go to http://localhost:3000/ and you'll see: |
|
31 | + mysql> flush privileges; |
|
|
38 | - "Welcome aboard: You're riding Ruby on Rails!" |
|
32 | + Query OK, 0 rows affected (0.00 sec) |
|
|
39 | - |
|
||
|
|
40 | - 4. Follow the guidelines to start developing your application. You can find |
|
||
|
|
41 | - the following resources handy: |
|
||
|
|
42 |
|
33 | ||
|
|
43 | - * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html |
|
34 | + === 2. Install RVM |
|
|
44 | - * Ruby on Rails Tutorial Book: http://www.railstutorial.org/ |
|
||
|
|
45 |
|
35 | ||
|
|
|
36 | + Since Ubuntu has dedicated package for RVM we will use that. Just follow instruction given in https://github.com/rvm/ubuntu_rvm. For your convenience, the step are reproduced here. | ||
|
|
46 |
|
37 | ||
|
|
47 | - == Debugging Rails |
|
38 | + First, we install necessary package for installing RVM. |
|
|
48 |
|
39 | ||
|
|
49 | - Sometimes your application goes wrong. Fortunately there are a lot of tools that |
|
40 | + cafe@grader:~$ sudo apt install software-properties-common |
|
|
50 | - will help you debug it and get it back on the rails. |
|
41 | + |
|
|
|
42 | + Second, we add the custom PPA, update the system and install RVM. | ||
|
|
51 |
|
43 | ||
|
|
52 | - First area to check is the application log files. Have "tail -f" commands |
|
44 | + cafe@grader:~$ sudo apt-add-repository -y ppa:rael-gc/rvm |
|
|
53 | - running on the server.log and development.log. Rails will automatically display |
|
45 | + cafe@grader:~$ sudo apt-get update |
|
|
54 | - debugging and runtime information to these files. Debugging info will also be |
|
46 | + cafe@grader:~$ sudo apt-get install rvm |
|
|
55 | - shown in the browser on requests from 127.0.0.1. |
|
||
|
|
56 | - |
|
||
|
|
57 | - You can also log your own messages directly into the log file from your code |
|
||
|
|
58 | - using the Ruby logger class from inside your controllers. Example: |
|
||
|
|
59 |
|
47 | ||
|
|
60 | - class WeblogController < ActionController::Base |
|
48 | + This is very important. You have to logout and login again since RVM change a lots of system. |
|
|
61 | - def destroy |
|
49 | + |
|
|
62 | - @weblog = Weblog.find(params[:id]) |
|
50 | + If you are using GUI version of Ubuntu, be sure to have Gnome Terminal (or any other terminal you are using) perform login every time. This can be done by mark the check box "Run command as a login shell" in Gnome terminal or by adding --login to bash. |
|
|
63 | - @weblog.destroy |
|
51 | + |
|
|
64 | - logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!") |
|
52 | + === 3. Install necessary package |
|
|
65 | - end |
|
||
|
|
66 | - end |
|
||
|
|
67 |
|
53 | ||
|
|
68 | - The result will be a message in your log file along the lines of: |
|
54 | + cafe@grader:~$ sudo apt install libmysqlclient-dev default-jdk unzip nodejs php7.2-cli apache2 dirmngr gnupg apache2-dev |
|
|
69 |
|
55 | ||
|
|
70 | - Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1! |
|
56 | + curl build-essential |
|
|
|
57 | + | ||
|
|
|
58 | + === 4. Install cafe-grader | ||
|
|
71 |
|
59 | ||
|
|
72 | - More information on how to use the logger is at http://www.ruby-doc.org/core/ |
|
60 | + First, ensure that RVM is installed correctly. |
|
|
73 |
|
61 | ||
|
|
74 | - Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are |
|
62 | + cafe@grader:~$ rvm |
|
|
75 | - several books available online as well: |
|
63 | + |
|
|
|
64 | + If you get a result similar to this. | ||
|
|
76 |
|
65 | ||
|
|
77 | - * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe) |
|
66 | + Command 'rvm' not found, but there are 21 similar ones. |
|
|
78 | - * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide) |
|
||
|
|
79 |
|
67 | ||
|
|
80 | - These two books will bring you up to speed on the Ruby language and also on |
|
68 | + It is very likely that you have not re-login or you are using bash without --login. Please do so and re-read the installation of RVM on Ubuntu https://github.com/rvm/ubuntu_rvm again. |
|
|
81 | - programming in general. |
|
||
|
|
82 |
|
69 | ||
|
|
83 | - |
|
70 | + Next, we will let the install script do the work of installing cafe-grader. Please prepare the DATABASENAME, USERNAME and PASSWORD as the script will ask for that. Make sure that you run the script from the home directory of the user. |
|
|
84 | - == Debugger |
|
||
|
|
85 |
|
71 | ||
|
|
86 | - Debugger support is available through the debugger command when you start your |
|
72 | + cafe@grader:~$ wget https://github.com/cafe-grader-team/cafe-grader-judge-scripts/raw/master/installer/install.sh |
|
|
87 | - Mongrel or WEBrick server with --debugger. This means that you can break out of |
|
73 | + cafe@grader:~$ . ./install.sh |
|
|
88 | - execution at any point in the code, investigate and change the model, and then, |
|
74 | + |
|
|
89 | - resume execution! You need to install ruby-debug to run the server in debugging |
|
75 | + After installation is finished, grader is ready to run in development mode via WEBrick. We will try that by the following command which will start a grader accessible via http://localhost:3000/. You can try logging in to the system and verify that it is actually work. |
|
|
90 | - mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example: |
|
||
|
|
91 |
|
76 | ||
|
|
92 | - class WeblogController < ActionController::Base |
|
77 | + cafe@grader:~/cafe_grader/web$ rails s |
|
|
93 | - def index |
|
78 | + |
|
|
94 | - @posts = Post.all |
|
79 | + If Everything is OK, stop the WEBrick by Ctrl-C. |
|
|
95 | - debugger |
|
||
|
|
96 | - end |
|
||
|
|
97 | - end |
|
||
|
|
98 |
|
80 | ||
|
|
99 | - So the controller will accept the action, run the first line, then present you |
|
81 | + We are almost done. The last step is to set up apache and Phusion so that cafe-grader is served by apache. |
|
|
100 | - with a IRB prompt in the server window. Here you can do things like: |
|
82 | + |
|
|
|
83 | + === 5. Deploy cafe-grader on Phusion passenger via apache | ||
|
|
101 |
|
84 | ||
|
|
102 | - >> @posts.inspect |
|
85 | + This will install a Passenger mod for apache. You can start by visiting https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/apache/oss/install_passenger_main.html and fllow through the guide. We have reproduce the step here for Ubuntu 18.04. For other version, please select the appropriate one on the previous link. |
|
|
103 | - => "[#<Post:0x14a6be8 |
|
86 | + |
|
|
104 | - @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>, |
|
87 | + The deploy is divided into two parts: Installing Passenger and deploying the app. |
|
|
105 | - #<Post:0x14a6620 |
|
88 | + |
|
|
106 | - @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]" |
|
89 | + ==== 5.1. Installing Passenger as a mod for apache via PPA and enable it. |
|
|
107 | - >> @posts.first.title = "hello from a debugger" |
|
||
|
|
108 | - => "hello from a debugger" |
|
||
|
|
109 |
|
90 | ||
|
|
110 | - ...and even better, you can examine how your runtime objects actually work: |
|
91 | + cafe@grader:~$ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 561F9B9CAC40B2F7 |
|
|
111 | - |
|
92 | + cafe@grader:~$ sudo apt-get install -y apt-transport-https ca-certificates |
|
|
112 | - >> f = @posts.first |
|
93 | + cafe@grader:~$ sudo sh -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger bionic main > /etc/apt/sources.list.d/passenger.list' |
|
|
113 | - => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}> |
|
94 | + cafe@grader:~$ sudo apt-get update |
|
|
114 | - >> f. |
|
95 | + cafe@grader:~$ sudo apt-get install -y libapache2-mod-passenger |
|
|
115 | - Display all 152 possibilities? (y or n) |
|
96 | + cafe@grader:~$ sudo a2enmod passenger |
|
|
116 | - |
|
||
|
|
117 | - Finally, when you're ready to resume execution, you can enter "cont". |
|
||
|
|
118 |
|
97 | ||
|
|
119 |
|
98 | ||
|
|
120 | - == Console |
|
99 | + cafe@grader:~$ sudo apache2ctl restart |
|
|
|
100 | + | ||
|
|
|
101 | + Finally, we should check that passenger is installed correctly. Run the following command and fix anything as suggested by the command. | ||
|
|
|
102 | + | ||
|
|
|
103 | + cafe@grader:~$ sudo /usr/bin/passenger-config validate-install | ||
|
|
|
104 | + | ||
|
|
|
105 | + ==== 5.2. Deploying the app. First, we determine the exact location of our ruby that is installed via RVM. | ||
|
|
121 |
|
106 | ||
|
|
122 | - The console is a Ruby shell, which allows you to interact with your |
|
107 | + cafe@grader:~$ passenger-config about ruby-command |
|
|
123 | - application's domain model. Here you'll have all parts of the application |
|
108 | + passenger-config was invoked through the following Ruby interpreter: |
|
|
124 | - configured, just like it is when the application is running. You can inspect |
|
109 | + Command: /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
|
125 | - domain models, change values, and save to the database. Starting the script |
|
110 | + Version: ruby 2.3.7p456 (2018-03-28 revision 63024) [x86_64-linux] |
|
|
126 | - without arguments will launch it in the development environment. |
|
111 | + To use in Apache: PassengerRuby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
|
|
112 | + To use in Nginx : passenger_ruby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby | ||
|
|
|
113 | + To use with Standalone: /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby /usr/bin/passenger start | ||
|
|
127 |
|
114 | ||
|
|
128 | - To start the console, run <tt>rails console</tt> from the application |
|
115 | + Then, take note of the path after "Command". For this guide, it is /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
|
129 | - directory. |
|
116 | + |
|
|
|
117 | + Assuming that cafe-grader is installed at /home/cafe/cafe_grader, we will edit the Apache's site config file /etc/apache2/site-enabled/000-default.conf as follow. | ||
|
|
130 |
|
118 | ||
|
|
131 | - Options: |
|
119 | + <VirtualHost *:80> |
|
|
|
120 | + #ServerName www.example.com | ||
|
|
|
121 | + | ||
|
|
|
122 | + ServerAdmin webmaster@localhost | ||
|
|
|
123 | + # dont forget to change the document root | ||
|
|
|
124 | + DocumentRoot /home/cafe/cafe_grader/web/public | ||
|
|
|
125 | + | ||
|
|
|
126 | + ErrorLog ${APACHE_LOG_DIR}/error.log | ||
|
|
|
127 | + CustomLog ${APACHE_LOG_DIR}/access.log combined | ||
|
|
132 |
|
128 | ||
|
|
133 | - * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications |
|
129 | + # add Passenger |
|
|
134 | - made to the database. |
|
130 | + PassengerRuby /home/cafe/.rvm/gems/ruby-2.3.7/wrappers/ruby |
|
|
135 | - * Passing an environment name as an argument will load the corresponding |
|
||
|
|
136 | - environment. Example: <tt>rails console production</tt>. |
|
||
|
|
137 |
|
131 | ||
|
|
138 | - To reload your controllers and models after launching the console run |
|
132 | + # our cafe-grader app |
|
|
139 | - <tt>reload!</tt> |
|
133 | + <Directory /home/cafe/cafe_grader/web/public> |
|
|
140 | - |
|
134 | + Allow from all |
|
|
141 | - More information about irb can be found at: |
|
135 | + Options -MultiViews |
|
|
142 | - link:http://www.rubycentral.org/pickaxe/irb.html |
|
136 | + Require all granted |
|
|
|
137 | + </Directory> | ||
|
|
|
138 | + </VirtualHost> | ||
|
|
143 |
|
139 | ||
|
|
144 |
|
140 | ||
|
|
145 | - == dbconsole |
|
141 | + Be noted that we make 3 modifications: 1) change DocumentRoot, 2) add PassengerRuby option and add 3) Directory directive |
|
|
146 | - |
|
142 | + As the last step, we restart apache again and the site is ready to be used. |
|
|
147 | - You can go to the command line of your database directly through <tt>rails |
|
||
|
|
148 | - dbconsole</tt>. You would be connected to the database with the credentials |
|
||
|
|
149 | - defined in database.yml. Starting the script without arguments will connect you |
|
||
|
|
150 | - to the development database. Passing an argument will connect you to a different |
|
||
|
|
151 | - database, like <tt>rails dbconsole production</tt>. Currently works for MySQL, |
|
||
|
|
152 | - PostgreSQL and SQLite 3. |
|
||
|
|
153 | - |
|
||
|
|
154 | - == Description of Contents |
|
||
|
|
155 | - |
|
||
|
|
156 | - The default directory structure of a generated Ruby on Rails application: |
|
||
|
|
157 | - |
|
||
|
|
158 | - |-- app |
|
||
|
|
159 | - | |-- assets |
|
||
|
|
160 | - | |-- images |
|
||
|
|
161 | - | |-- javascripts |
|
||
|
|
162 | - | `-- stylesheets |
|
||
|
|
163 | - | |-- controllers |
|
||
|
|
164 | - | |-- helpers |
|
||
|
|
165 | - | |-- mailers |
|
||
|
|
166 | - | |-- models |
|
||
|
|
167 | - | `-- views |
|
||
|
|
168 | - | `-- layouts |
|
||
|
|
169 | - |-- config |
|
||
|
|
170 | - | |-- environments |
|
||
|
|
171 | - | |-- initializers |
|
||
|
|
172 | - | `-- locales |
|
||
|
|
173 | - |-- db |
|
||
|
|
174 | - |-- doc |
|
||
|
|
175 | - |-- lib |
|
||
|
|
176 | - | `-- tasks |
|
||
|
|
177 | - |-- log |
|
||
|
|
178 | - |-- public |
|
||
|
|
179 | - |-- script |
|
||
|
|
180 | - |-- test |
|
||
|
|
181 | - | |-- fixtures |
|
||
|
|
182 | - | |-- functional |
|
||
|
|
183 | - | |-- integration |
|
||
|
|
184 | - | |-- performance |
|
||
|
|
185 | - | `-- unit |
|
||
|
|
186 | - |-- tmp |
|
||
|
|
187 | - | |-- cache |
|
||
|
|
188 | - | |-- pids |
|
||
|
|
189 | - | |-- sessions |
|
||
|
|
190 | - | `-- sockets |
|
||
|
|
191 | - `-- vendor |
|
||
|
|
192 | - |-- assets |
|
||
|
|
193 | - `-- stylesheets |
|
||
|
|
194 | - `-- plugins |
|
||
|
|
195 | - |
|
||
|
|
196 | - app |
|
||
|
|
197 | - Holds all the code that's specific to this particular application. |
|
||
|
|
198 | - |
|
||
|
|
199 | - app/assets |
|
||
|
|
200 | - Contains subdirectories for images, stylesheets, and JavaScript files. |
|
||
|
|
201 |
|
143 | ||
|
|
202 | - app/controllers |
|
144 | + cafe@grader:~$ sudo apache2ctl restart |
|
|
203 | - Holds controllers that should be named like weblogs_controller.rb for |
|
145 | + |
|
|
204 | - automated URL mapping. All controllers should descend from |
|
146 | + Now it is done, you can login to the grader with user 'root' and password 'ioionrails' |
|
|
205 | - ApplicationController which itself descends from ActionController::Base. |
|
||
|
|
206 | - |
|
||
|
|
207 | - app/models |
|
||
|
|
208 | - Holds models that should be named like post.rb. Models descend from |
|
||
|
|
209 | - ActiveRecord::Base by default. |
|
||
|
|
210 | - |
|
||
|
|
211 | - app/views |
|
||
|
|
212 | - Holds the template files for the view that should be named like |
|
||
|
|
213 | - weblogs/index.html.erb for the WeblogsController#index action. All views use |
|
||
|
|
214 | - eRuby syntax by default. |
|
||
|
|
215 | - |
|
||
|
|
216 | - app/views/layouts |
|
||
|
|
217 | - Holds the template files for layouts to be used with views. This models the |
|
||
|
|
218 | - common header/footer method of wrapping views. In your views, define a layout |
|
||
|
|
219 | - using the <tt>layout :default</tt> and create a file named default.html.erb. |
|
||
|
|
220 | - Inside default.html.erb, call <% yield %> to render the view using this |
|
||
|
|
221 | - layout. |
|
||
|
|
222 | - |
|
||
|
|
223 | - app/helpers |
|
||
|
|
224 | - Holds view helpers that should be named like weblogs_helper.rb. These are |
|
||
|
|
225 | - generated for you automatically when using generators for controllers. |
|
||
|
|
226 | - Helpers can be used to wrap functionality for your views into methods. |
|
||
|
|
227 | - |
|
||
|
|
228 | - config |
|
||
|
|
229 | - Configuration files for the Rails environment, the routing map, the database, |
|
||
|
|
230 | - and other dependencies. |
|
||
|
|
231 |
|
147 | ||
|
|
232 | - db |
|
||
|
|
233 | - Contains the database schema in schema.rb. db/migrate contains all the |
|
||
|
|
234 | - sequence of Migrations for your schema. |
|
||
|
|
235 | - |
|
||
|
|
236 | - doc |
|
||
|
|
237 | - This directory is where your application documentation will be stored when |
|
||
|
|
238 | - generated using <tt>rake doc:app</tt> |
|
||
|
|
239 | - |
|
||
|
|
240 | - lib |
|
||
|
|
241 | - Application specific libraries. Basically, any kind of custom code that |
|
||
|
|
242 | - doesn't belong under controllers, models, or helpers. This directory is in |
|
||
|
|
243 | - the load path. |
|
||
|
|
244 | - |
|
||
|
|
245 | - public |
|
||
|
|
246 | - The directory available for the web server. Also contains the dispatchers and the |
|
||
|
|
247 | - default HTML files. This should be set as the DOCUMENT_ROOT of your web |
|
||
|
|
248 | - server. |
|
||
|
|
249 | - |
|
||
|
|
250 | - script |
|
||
|
|
251 | - Helper scripts for automation and generation. |
|
||
|
|
252 | - |
|
||
|
|
253 | - test |
|
||
|
|
254 | - Unit and functional tests along with fixtures. When using the rails generate |
|
||
|
|
255 | - command, template test files will be generated for you and placed in this |
|
||
|
|
256 | - directory. |
|
||
|
|
257 | - |
|
||
|
|
258 | - vendor |
|
||
|
|
259 | - External libraries that the application depends on. Also includes the plugins |
|
||
|
|
260 | - subdirectory. If the app has frozen rails, those gems also go here, under |
|
||
|
|
261 | - vendor/rails/. This directory is in the load path. |
|
||
You need to be logged in to leave comments.
Login now