Merge api06 branch to 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/index.php/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 primary keys plugin for active record (minimum version 0.9.1)
15     sudo gem install composite_primary_keys
16 * Make sure you have a MTA listening on localhost:25 if you want mail
17     sudo apt-get install exim4
18 * Start the server
19     script/server
20 * Thats it
21
22 =API CHANGES FOR EDITOR AUTHORS
23
24 See
25
26 The information about the next version of the protocol API 0.6 is available at 
27 http://wiki.openstreetmap.org/index.php/OSM_Protocol_Version_0.6
28 http://wiki.openstreetmap.org/index.php/REST
29
30 =HACKING
31
32 * Log in to your site (proably localhost:3000)
33 * Create a user and confirm it (by setting the active flag to true in the users table of the database
34 * You want to play with the API (probably at http://localhost:3000/api/0.6/node/create etc)
35 * Lots of tests are needed to test the API. To run the tests use 
36     rake test
37 * Lots of little things to make the site work like the old one.
38
39 =Bugs
40
41 See the 'rails_port' component for bugs:
42 http://trac.openstreetmap.org/query?status=new&status=assigned&status=reopened&component=rails_port&order=priority