Create a directory for branches of the main web site, and make a branch
[rails.git] / doc / README_FOR_APP
1 This is the OpenStreetMap rails server codebase. Documentation is currently extremely incomplete. Please help by writing docs and moving any SQL you see to use models etc.
2
3 =INSTALL
4
5 * Get rails working (http://www.rubyonrails.org/)
6 * Make your db (see db/README)
7 * Install ruby libxml bindings:
8     sudo apt-get install libxml-ruby1.8 libxml-parser-ruby1.8
9 * Install primary keys plugin for active record (minimum version 0.9.1)
10     sudo gem install composite_primary_keys
11 * Make sure you have a MTA listening on localhost:25 if you want mail
12     sudo apt-get install exim4
13 * Start the server
14     script/server
15 * Thats it
16
17 =API CHANGES FOR EDITOR AUTHORS
18
19 See
20
21 http://wiki.openstreetmap.org/index.php/REST#Changes_in_the_upcoming_0.4_API
22
23 =HACKING
24
25 * Log in to your site (proably localhost:3000)
26 * Create a user and confirm it
27 * You want to play with the API (probably at http://localhost:3000/api/0.5/node/create etc)
28 * Lots of tests are needed to test the API.
29 * Lots of little things to make the site work like the old one.
30
31 =Bugs
32
33 See the 'rails_port' component for bugs:
34 http://trac.openstreetmap.org/query?status=new&status=assigned&status=reopened&component=rails_port&order=priority