Development Setup

Version 2 (J. Simmons, 10/16/2011 06:37 pm)

1 1 Matthew Sears
h1. Development Setup
2 1 Matthew Sears
3 2 J. Simmons
The following instructions are meant to help get the ODE application up and running on your local workstation.  Note, these instructions assume you are setting up a development environment on Linux/OS X.
4 1 Matthew Sears
5 1 Matthew Sears
h1.  Code checkout
6 1 Matthew Sears
7 1 Matthew Sears
To get started, create a local repository with svn checkout:
8 1 Matthew Sears
9 1 Matthew Sears
<pre>
10 1 Matthew Sears
svn checkout https://opendesignengine.net/svn/ode/trunk
11 1 Matthew Sears
</pre>
12 1 Matthew Sears
13 1 Matthew Sears
h1. Create Development Database
14 1 Matthew Sears
15 1 Matthew Sears
You will need to setup a local development MySQL database and call 'ode_development'.  Next we need to create a new database.yml so the application knows how to connect to the database.  To accomplish this, simple copy the database.yml.exampe file:
16 1 Matthew Sears
17 1 Matthew Sears
<pre>
18 1 Matthew Sears
cp config/database.yml.example confit/database.yml
19 1 Matthew Sears
</pre>
20 1 Matthew Sears
21 1 Matthew Sears
Under the production: section of the the config fill, fill in the database name, username, and password.
22 1 Matthew Sears
23 1 Matthew Sears
h1. Bundler
24 1 Matthew Sears
25 1 Matthew Sears
To install the required third-party gems to run the ODE application, we run the following Bundler command:
26 1 Matthew Sears
27 1 Matthew Sears
<pre>
28 1 Matthew Sears
bundle install
29 1 Matthew Sears
</pre>
30 1 Matthew Sears
31 1 Matthew Sears
Note: you will need to install Bundler first (gem install bundler)
32 1 Matthew Sears
33 1 Matthew Sears
h1. Database Preparation
34 1 Matthew Sears
35 1 Matthew Sears
To prepare the database, we first need to run migrations:
36 1 Matthew Sears
37 1 Matthew Sears
<pre>
38 1 Matthew Sears
RAILS_ENV=production rake db:migrate
39 1 Matthew Sears
</pre>
40 1 Matthew Sears
41 1 Matthew Sears
We now need some seed data to get started:
42 1 Matthew Sears
43 1 Matthew Sears
<pre>
44 1 Matthew Sears
RAILS_ENV=production rake db:seed
45 1 Matthew Sears
</pre>
46 1 Matthew Sears
47 1 Matthew Sears
h1. Running the Application
48 1 Matthew Sears
49 1 Matthew Sears
Now we should be ready to run the application locally:
50 1 Matthew Sears
51 1 Matthew Sears
<pre>
52 1 Matthew Sears
RAILS_ENV=production script/server
53 1 Matthew Sears
</pre>
54 1 Matthew Sears
55 1 Matthew Sears
If all goes well, you should be able to open the application at http://localhost:3000