Commit 7df1673a819418035fc02ac9109dda6f4b9d77dd
1 parent
e66588b4
Exists in
master
and in
29 other branches
ActionItem8: preparing documentation
git-svn-id: https://svn.colivre.coop.br/svn/noosfero/trunk@441 3f533792-8f58-4932-b0fe-aaf55b0a4547
Showing
2 changed files
with
54 additions
and
51 deletions
Show diff stats
doc/DEVELOPMENT
| @@ -1,49 +0,0 @@ | @@ -1,49 +0,0 @@ | ||
| 1 | -== Setting up a Noosfero development/test environment | ||
| 2 | - | ||
| 3 | -=== Requirements | ||
| 4 | - | ||
| 5 | -You need to have a Subversion client (svn) installed, as well as: | ||
| 6 | - | ||
| 7 | -* Ruby:http://www.ruby-lang.org/ | ||
| 8 | -* Rake:http://rake.rubyforge.org/ | ||
| 9 | -* Ruby-GetText:http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext | ||
| 10 | -* Mocha:http://mocha.rubyforge.org/ | ||
| 11 | -* Ruby-sqlite3:http://rubyforge.org/projects/sqlite-ruby | ||
| 12 | - | ||
| 13 | -There are Debian packages available for all of them. Try: | ||
| 14 | - | ||
| 15 | - # aptitude install svn ruby rake libgettext-ruby libmocha-ruby libsqlite3-ruby | ||
| 16 | - | ||
| 17 | -If you have problems with the setup, use the development mailing list. In | ||
| 18 | -special its possible that the requirements list above is not complete. | ||
| 19 | - | ||
| 20 | -=== Getting Noosfero source | ||
| 21 | - | ||
| 22 | - $ svn checkout https://svn.colivre.coop.br/svn/noosfero/trunk/ noosfero | ||
| 23 | - $ cd noosfero | ||
| 24 | - $ cp config/database.yml.sqlite3 config/database.yml | ||
| 25 | - $ rake db:migrate | ||
| 26 | - | ||
| 27 | -You should now be ready to go. Issue the following command to start the Rails | ||
| 28 | -development server: | ||
| 29 | - | ||
| 30 | - $ ./script/server | ||
| 31 | - | ||
| 32 | -The server will be available at http://localhost:3000/ . If you want to use | ||
| 33 | -another port than 3000, you can use the -p option of ./script/server: | ||
| 34 | - | ||
| 35 | - & ./script/server -p 9999 | ||
| 36 | - | ||
| 37 | -The above command makes the server available at http://localhost:9999/ | ||
| 38 | - | ||
| 39 | -== Reporting bugs | ||
| 40 | - | ||
| 41 | -Use Noosfero Tracker application at http://www.colivre.coop.br/Noosfero. | ||
| 42 | - | ||
| 43 | -== Helping with development | ||
| 44 | - | ||
| 45 | -* It's recommended that you subscribe to the "development mailing | ||
| 46 | - list":http://ynternet.net/mailman/listinfo/noosfero | ||
| 47 | -* If you have a patch, create an appropriate action item | ||
| 48 | - (bugs/requirement/enhancement) in the Tracker web (see "Reporting bugs" | ||
| 49 | - above) of type. |
doc/README_FOR_APP
| 1 | -Use this README file to introduce your application and point to useful places in the API for learning more. | ||
| 2 | -Run "rake appdoc" to generate API documentation for your models and controllers. | ||
| 3 | \ No newline at end of file | 1 | \ No newline at end of file |
| 2 | += Noosfero: a free web-based social platform | ||
| 3 | + | ||
| 4 | +== Setting up a Noosfero development/test environment | ||
| 5 | + | ||
| 6 | +Noosfero is written in Ruby with the "Rails framework":http://www.rubyonrails.org, | ||
| 7 | +so the process of setting it up is pretty similar to other Rails applications. | ||
| 8 | + | ||
| 9 | +=== Requirements | ||
| 10 | + | ||
| 11 | +You need to have a Subversion client (svn) installed, as well as: | ||
| 12 | + | ||
| 13 | +* Ruby:http://www.ruby-lang.org/ | ||
| 14 | +* Rake:http://rake.rubyforge.org/ | ||
| 15 | +* Ruby-GetText:http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext | ||
| 16 | +* Mocha:http://mocha.rubyforge.org/ | ||
| 17 | +* Ruby-sqlite3:http://rubyforge.org/projects/sqlite-ruby | ||
| 18 | + | ||
| 19 | +There are Debian packages available for all of them. Try: | ||
| 20 | + | ||
| 21 | + # aptitude install svn ruby rake libgettext-ruby libmocha-ruby libsqlite3-ruby | ||
| 22 | + | ||
| 23 | +If you have problems with the setup, use the development mailing list. In | ||
| 24 | +special its possible that the requirements list above is not complete. | ||
| 25 | + | ||
| 26 | +=== Getting Noosfero source | ||
| 27 | + | ||
| 28 | + $ svn checkout https://svn.colivre.coop.br/svn/noosfero/trunk/ noosfero | ||
| 29 | + $ cd noosfero | ||
| 30 | + $ cp config/database.yml.sqlite3 config/database.yml | ||
| 31 | + $ rake db:migrate | ||
| 32 | + | ||
| 33 | +You should now be ready to go. Issue the following command to start the Rails | ||
| 34 | +development server: | ||
| 35 | + | ||
| 36 | + $ ./script/server | ||
| 37 | + | ||
| 38 | +The server will be available at http://localhost:3000/ . If you want to use | ||
| 39 | +another port than 3000, you can use the -p option of ./script/server: | ||
| 40 | + | ||
| 41 | + & ./script/server -p 9999 | ||
| 42 | + | ||
| 43 | +The above command makes the server available at http://localhost:9999/ | ||
| 44 | + | ||
| 45 | +== Reporting bugs | ||
| 46 | + | ||
| 47 | +Use Noosfero Tracker application at http://www.colivre.coop.br/Noosfero. | ||
| 48 | + | ||
| 49 | +== Helping with development | ||
| 50 | + | ||
| 51 | +* It's recommended that you subscribe to the "development mailing | ||
| 52 | + list":http://ynternet.net/mailman/listinfo/noosfero | ||
| 53 | +* If you have a patch, create an appropriate action item | ||
| 54 | + (bugs/requirement/enhancement) in the Tracker web (see "Reporting bugs" | ||
| 55 | + above) of type. |