piotrj / insoshi forked from insoshi/insoshi

The open source social networking platform in Ruby on Rails from the author of RailsSpace

This URL has Read+Write access

insoshi / README.rdoc
raw normal view history
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 1 = Insoshi social software
189a6c6b » mhartl 2008-02-18 init 2
ffc3eaf7 » mhartl 2008-04-29 Fixed README typo 3 NOTE: If you downloaded a zipped archive of Insoshi, we strongly encourage you to clone the Insoshi Git repository instead. See the instructions below, and also see
714b9bfa » mhartl 2008-04-26 Added links to installation... 4
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 5 http://sites.google.com/a/insoshi.com/insoshi-guides/Installation
714b9bfa » mhartl 2008-04-26 Added links to installation... 6
7 for more details.
8
9 To follow our progress, join the Insoshi developer community site at
10
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 11 http://dogfood.insoshi.com/signup
714b9bfa » mhartl 2008-04-26 Added links to installation... 12
13 and join the Insoshi Google group at
3c255dac » mhartl 2008-04-10 Linked to Google group in R... 14
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 15 http://groups.google.com/group/insoshi/subscribe
3c255dac » mhartl 2008-04-10 Linked to Google group in R... 16
189a6c6b » mhartl 2008-02-18 init 17
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 18 == Get Git
189a6c6b » mhartl 2008-02-18 init 19
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 20 The source code to Insoshi is managed via Git, a version control system developed by Linus Torvalds to host the Linux kernel.
21
22 The first step is to install it from here:
189a6c6b » mhartl 2008-02-18 init 23
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 24 http://git.or.cz/
189a6c6b » mhartl 2008-02-18 init 25
3ca3eb2c » mhartl 2008-04-07 Moved INSTALL to the README... 26 Linux and Mac users should have no problems; Windows users might have to install Cygwin (http://cygwin.com/) first.
189a6c6b » mhartl 2008-02-18 init 27
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 28 For more detailed information, check out our guide for Installing Git under Git Guides at
29
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 30 http://docs.insoshi.com
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 31
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 32 == Install libraries and gems
189a6c6b » mhartl 2008-02-18 init 33
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 34 === Libraries
189a6c6b » mhartl 2008-02-18 init 35
7cd47c9b » mhartl 2008-05-09 Removed strict image_scienc... 36 You'll need to install FreeImage or some other image processor (such as ImageMagick/RMagick), SQLite, and (optionally) MySQL. Install instructions for all three are easy to find using Google.
189a6c6b » mhartl 2008-02-18 init 37
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 38 === Gems
189a6c6b » mhartl 2008-02-18 init 39
3ca3eb2c » mhartl 2008-04-07 Moved INSTALL to the README... 40 You probably have Rails already, but might not have the others.
189a6c6b » mhartl 2008-02-18 init 41
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 42 $ sudo gem install rails
43 $ sudo gem install ferret
44 $ sudo gem install sqlite3-ruby
45 $ sudo gem install mysql
189a6c6b » mhartl 2008-02-18 init 46
7cd47c9b » mhartl 2008-05-09 Removed strict image_scienc... 47 If you're using FreeImage/ImageScience, you'll also need the image_science gem:
48
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 49 $ sudo gem install image_science
7cd47c9b » mhartl 2008-05-09 Removed strict image_scienc... 50
51
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 52 == Installing the app
189a6c6b » mhartl 2008-02-18 init 53
3ca3eb2c » mhartl 2008-04-07 Moved INSTALL to the README... 54 Here are the steps to get up and running with the Insoshi Rails app.
189a6c6b » mhartl 2008-02-18 init 55
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 56 === Git steps
189a6c6b » mhartl 2008-02-18 init 57
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 58 Our public Git repository is hosted on GitHub and can be viewed at
59
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 60 http://github.com/insoshi/insoshi
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 61
62 You can clone the the repository with the command
189a6c6b » mhartl 2008-02-18 init 63
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 64 $ git clone git://github.com/insoshi/insoshi.git
189a6c6b » mhartl 2008-02-18 init 65
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 66 The clone make take a moment to complete (mainly due to the frozen Rails gems).
189a6c6b » mhartl 2008-02-18 init 67
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 68 Then make a local Git branch for yourself:
189a6c6b » mhartl 2008-02-18 init 69
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 70 $ git checkout -b <local_branch>
189a6c6b » mhartl 2008-02-18 init 71
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 72 where you should replace <local_branch> with the name of your choice (without angle brackets!).
189a6c6b » mhartl 2008-02-18 init 73
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 74 For more information on configuring your local clone of our repository, check out our Git Guides at
189a6c6b » mhartl 2008-02-18 init 75
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 76 http://docs.insoshi.com
189a6c6b » mhartl 2008-02-18 init 77
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 78 which also includes a scripted Quick Local Repository Setup.
189a6c6b » mhartl 2008-02-18 init 79
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 80 === Config files and tests
189a6c6b » mhartl 2008-02-18 init 81
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 82 You will to set up your database configuration. If you're using SQLite, you can just copy the example file
189a6c6b » mhartl 2008-02-18 init 83
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 84 $ cp config/database.example config/database.yml
4da90111 » mhartl 2008-04-23 Updated README for new inst... 85
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 86 If you're using MySQL, you'll need to create a configure the database.yml manually. The easiest way is to copy and modify one from an existing Rails application or from a new Rails project that explicitly uses MySQL (rails -d mysql <mysql project>).
87
88 Run the following custom rake task
4da90111 » mhartl 2008-04-23 Updated README for new inst... 89
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 90 $ rake install
4da90111 » mhartl 2008-04-23 Updated README for new inst... 91
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 92 The install rake task runs the database migration and performs some additional setup tasks (generate an encryption keypair for password management, creating an admin account, etc.)
93
94 If the install step fails, you may not have properly set up the configuration files.
95
96 Then prepare the test database and run the tests (which are actually RSpec examples in the spec/ directory):
4da90111 » mhartl 2008-04-23 Updated README for new inst... 97
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 98 $ rake db:test:prepare
99 $ rake spec
189a6c6b » mhartl 2008-02-18 init 100
7cd47c9b » mhartl 2008-05-09 Removed strict image_scienc... 101 If the tests fail in the Photos controller test, double-check that an image processor is properly installed.
05949106 » mhartl 2008-04-09 Documented admin user 102
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 103 === Loading sample data
189a6c6b » mhartl 2008-02-18 init 104
3ca3eb2c » mhartl 2008-04-07 Moved INSTALL to the README... 105 Now load the sample data and start the server:
189a6c6b » mhartl 2008-02-18 init 106
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 107 $ rake db:sample_data:reload
108 $ script/server
189a6c6b » mhartl 2008-02-18 init 109
3ca3eb2c » mhartl 2008-04-07 Moved INSTALL to the README... 110 The rake task loads sample data to make developing easier. All the sample users have email logins <name>@example.com, with password foobar.
189a6c6b » mhartl 2008-02-18 init 111
3ca3eb2c » mhartl 2008-04-07 Moved INSTALL to the README... 112 Go to http://localhost:3000 and log in as follows:
189a6c6b » mhartl 2008-02-18 init 113
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 114 email: michael@example.com
115 password: foobar
189a6c6b » mhartl 2008-02-18 init 116
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 117 === Admin user
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 118
119 To sign in as the pre-configured admin user, use
120
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 121 email: admin@example.com
122 password: admin
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 123
124 You should update the email address and password. Insoshi will display warning messages to remind you to do that.
125
a458cb78 » mhartl 2008-06-04 Admin preferences note 126 To see site preferences such as email settings, click on the "Admin view" and the click on "Prefs" in the menu. Click the "Edit" link to customize the preferences for your particular site.
127
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 128 === Start hacking
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 129
3ca3eb2c » mhartl 2008-04-07 Moved INSTALL to the README... 130 Now open the source code with your favorite editor and start hacking!
189a6c6b » mhartl 2008-02-18 init 131
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 132 Check out our Git Guides for information on how to manage your local development and how you can contribute your updates back to us:
133
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 134 http://docs.insoshi.com
2a847e6d » Long Nguyen 2008-04-25 Updated README to match wik... 135
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 136 == Stat tracker
189a6c6b » mhartl 2008-02-18 init 137
3ca3eb2c » mhartl 2008-04-07 Moved INSTALL to the README... 138 Note that there is a minimalist stat tracker that lets us keep track of how many different installs of Isoshi are out there. We don't collect any personal information, but if you don't want to be tracked just open application.html.erb and comment out the line after this one:
189a6c6b » mhartl 2008-02-18 init 139
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 140 <%# A tracker to tell us about the activity of Insoshi installs %>
189a6c6b » mhartl 2008-02-18 init 141
3b4257f0 » Piotr Jakubowski 2008-07-01 Put readme into rdoc format 142 == License
189a6c6b » mhartl 2008-02-18 init 143
3ca3eb2c » mhartl 2008-04-07 Moved INSTALL to the README... 144 See the file LICENSE.