source: subversion/sites/rails_port/doc/README_FOR_APP @ 7839

Last change on this file since 7839 was 6589, checked in by steve, 12 years ago

Lots of documentation updates, plus split out potlatch libraries in to lib

File size: 1.2 KB
Line 
1This 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
19See
20
21http://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
33See the 'rails_port' component for bugs:
34http://trac.openstreetmap.org/query?status=new&status=assigned&status=reopened&component=rails_port&order=priority
Note: See TracBrowser for help on using the repository browser.