]> git.openstreetmap.org Git - rails.git/blob - doc/README_FOR_APP
Merge 16110:16487 from trunk.
[rails.git] / doc / README_FOR_APP
1 This is the OpenStreetMap rails server codebase. Documentation is currently
2 extremely incomplete. Please help by writing docs and moving any SQL you
3 see to use models etc.
4
5 =INSTALL
6
7 Full information is available at 
8 http://wiki.openstreetmap.org/wiki/Rails
9
10 * Get rails working (http://www.rubyonrails.org/)
11 * Make your db (see db/README)
12 * Install ruby libxml bindings:
13     sudo apt-get install libxml-ruby1.8 libxml-parser-ruby1.8
14 * Install ImageMagick libraries & ruby gem:
15     sudo apt-get install libmagickcore-dev
16     sudo gem install rmagick
17 * Install primary keys plugin for active record (minimum version 0.9.1)
18     sudo gem install composite_primary_keys
19 * Make sure you have a MTA listening on localhost:25 if you want mail
20     sudo apt-get install exim4
21 * Start the server
22     script/server
23 * Thats it
24
25 =API CHANGES FOR EDITOR AUTHORS
26
27 See
28
29 The information about the next version of the protocol API 0.6 is available at 
30 http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
31 http://wiki.openstreetmap.org/wiki/REST
32
33 =HACKING
34
35 * Log in to your site (proably localhost:3000)
36 * Create a user and confirm it (by setting the active flag to true in the users table of the database
37 * You want to play with the API (probably at http://localhost:3000/api/0.6/node/create etc)
38 * Lots of tests are needed to test the API. To run the tests use 
39     rake test
40 * Lots of little things to make the site work like the old one.
41
42 =Bugs
43
44 See the 'rails_port' component for bugs:
45 http://trac.openstreetmap.org/query?status=new&status=assigned&status=reopened&component=rails_port&order=priority