Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 156 lines (86 sloc) 6.978 kb
89f2cdd adjusting readme
Raphael authored
1 ## Commit Guidlines
2 You are welcome to contribute, add and extend Diaspora however you see fit. We will do our best to incorporate everything that meets our guidelines.
3
4 All commits must be tested, and after each commit, all tests should be green before a pull request is sent. Please write your tests in Rspec or Test-Unit.
5
6 GEMS: We would like to keep external dependencies unduplicated. We're using Nokogiri, and Mongomapper, and EM::HttpRequest as much as possible. We have a few gems in the project we'd rather not use, but if you can, use dependencies we already have.
7
2c2cc9c atx-style headers
Daniel Vincent Grippi authored
8 # Diaspora
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
9
e72b558 fixed links in readme. added description used in our blog.
Daniel Vincent Grippi authored
10 The privacy aware, personally controlled, do-it-all, open source social network.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
11
259143b disclaimer
Daniel Vincent Grippi authored
12 **DISCLAIMER: THIS IS PRE-ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.**
84c60e5 @maxwell DG MS fixing webfinger, i hope to goodness
maxwell authored
13 These instructions are for machines running [Ubuntu](http://www.ubuntu.com/) or Mac OS X. We are developing Diaspora for the latest and greatest browsers, so please update your Firefox, Chrome or Safari to the latest and greatest.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
14
2c2cc9c atx-style headers
Daniel Vincent Grippi authored
15 ## Preparing your system
a5c86ac testing markup
Daniel Vincent Grippi authored
16 In order to run Diaspora, you will need to download the following dependencies (specific instructions follow):
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
17
d3b24f3 added installation of build tools
Daniel Vincent Grippi authored
18 - Build Tools - Packages needed to compile the components that follow.
19 - [Ruby](http://www.ruby-lang.org) - The Ruby programming language. (We're using **1.8.7**. It comes preinstalled on Mac OS X.)
4d7d937 updates to readme
Daniel Vincent Grippi authored
20 - [MongoDB](http://www.mongodb.org) - A snappy noSQL database.
d3b24f3 added installation of build tools
Daniel Vincent Grippi authored
21 - [OpenSSL](http://www.openssl.org/) - An encryption library. (It comes preinstalled on Mac OS X and Ubuntu.)
4d7d937 updates to readme
Daniel Vincent Grippi authored
22 - [ImageMagick](http://www.imagemagick.org/) - An Image processing library used to resize uploaded photos.
d3b24f3 added installation of build tools
Daniel Vincent Grippi authored
23 - [Git](http://git-scm.com/) - The fast version control system.
4d7d937 updates to readme
Daniel Vincent Grippi authored
24
d3b24f3 added installation of build tools
Daniel Vincent Grippi authored
25 After you have Ruby installed on your system, you will need to get RubyGems, then install Bundler:
4d7d937 updates to readme
Daniel Vincent Grippi authored
26
2c2cc9c atx-style headers
Daniel Vincent Grippi authored
27 - [RubyGems](http://rubygems.org/) - Source for Ruby gems.
e72b558 fixed links in readme. added description used in our blog.
Daniel Vincent Grippi authored
28 - [Bundler](http://gembundler.com/) - Gem management tool for Ruby projects.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
29
d3b24f3 added installation of build tools
Daniel Vincent Grippi authored
30 **We suggest using a package management system to download these dependencies. Trust us, it's going to make your life a lot easier. If you're using Mac OS X, you can use [homebrew](http://mxcl.github.com/homebrew/); and if you're using Ubuntu, just use [Synaptic](http://www.nongnu.org/synaptic/) (it comes pre-installed). The instructions below assume you have these installed.**
31
32 ### Build Tools
33
34 To install build tools on **Ubuntu**, run the following (includes the gcc and xml parsing dependencies):
35
36 sudo apt-get install build-essential libxslt1.1 libxslt1-dev libxml2
37
38 To install build tools on **Mac OS X**, you need to download and install [Xcode](http://developer.apple.com/technologies/tools/xcode.html).
a5c86ac testing markup
Daniel Vincent Grippi authored
39
40 ### Ruby
41
42 To install Ruby 1.8.7 on **Ubuntu**, run the following command:
43
fb9d504 more instructions
Daniel Vincent Grippi authored
44 sudo apt-get install ruby-full
a5c86ac testing markup
Daniel Vincent Grippi authored
45
46 If you're on **Mac OS X**, you already have Ruby on your system. Yay!
47
48 ### MongoDB
49
50 To install MongoDB on **Ubuntu**, run the following commands:
51
52
fb9d504 more instructions
Daniel Vincent Grippi authored
53 If you're running a 32-bit system, run `wget http://fastdl.mongodb.org/linux/mongodb-linux-i686-1.6.2.tgz`. If you're running a 64-bit system, run `wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-1.6.2.tgz`.
a5c86ac testing markup
Daniel Vincent Grippi authored
54
fb9d504 more instructions
Daniel Vincent Grippi authored
55 # extract
56 tar xzf mongodb-linux-i686-1.4.0.tgz
57 # create the required data directory
58 sudo mkdir -p /data/db
59 sudo chmod -Rv 777 /data/
a5c86ac testing markup
Daniel Vincent Grippi authored
60
61
62 To install MongoDB on **Mac OS X**, run the following:
63
fb9d504 more instructions
Daniel Vincent Grippi authored
64 brew install mongo
a5c86ac testing markup
Daniel Vincent Grippi authored
65
66 ### OpenSSL
67
68 If you're running either **Ubuntu** or **Mac OS X** you already have OpenSSL installed!
69
70 ### ImageMagick
71
72 To install ImageMagick on **Ubuntu**, run the following:
73
fa947b1 minor changes
Daniel Vincent Grippi authored
74 sudo apt-get install imagemagick libmagick9-dev
75
a5c86ac testing markup
Daniel Vincent Grippi authored
76 To install ImageMagick on **Mac OS X**, run the following:
77
fb9d504 more instructions
Daniel Vincent Grippi authored
78 brew install imagemagick
79
a5c86ac testing markup
Daniel Vincent Grippi authored
80 ### Git
81
82 To install Git on **Ubuntu**, run the following:
83
fb9d504 more instructions
Daniel Vincent Grippi authored
84 sudo apt-get install git-core
a5c86ac testing markup
Daniel Vincent Grippi authored
85
86 To install Git on **Mac OS X**, run the following:
87
fb9d504 more instructions
Daniel Vincent Grippi authored
88 brew install git
a5c86ac testing markup
Daniel Vincent Grippi authored
89
90
91 ### Rubygems
92
fb9d504 more instructions
Daniel Vincent Grippi authored
93 On **Ubuntu**, run the following:
94
95 wget http://production.cf.rubygems.org/rubygems/rubygems-1.3.7.tgz
96 tar -xf rubygems-1.3.7.tgz
97 cd rubygems-1.3.7
98 sudo ruby setup.rb
99 sudo ln -s /usr/bin/gem1.8 /usr/bin/gem
100
55f00eb @maxwell MS two dumb readme sudo changes
maxwell authored
101 On **Mac OS X**, RubyGems comes preinstalled; however, you might need to update it for use with the latest Bundler. To update RubyGems, run `sudo gem update --system`.
a5c86ac testing markup
Daniel Vincent Grippi authored
102
103
104 ### Bundler
105
55f00eb @maxwell MS two dumb readme sudo changes
maxwell authored
106 After RubyGems is updated, simply run `sudo gem install bundler` to get Bundler.
a5c86ac testing markup
Daniel Vincent Grippi authored
107
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
108
2c2cc9c atx-style headers
Daniel Vincent Grippi authored
109 ## Getting Diaspora
89d8e86 added git clone command
Daniel Vincent Grippi authored
110
111 git clone git@github.com:diaspora/diaspora.git
112
3de13d0 minor edit
Daniel Vincent Grippi authored
113 If you have never used github before, their [help desk](http://help.github.com/) has a pretty awesome guide on getting setup.
4d7d937 updates to readme
Daniel Vincent Grippi authored
114
115
2c2cc9c atx-style headers
Daniel Vincent Grippi authored
116 ## Running Diaspora
4d7d937 updates to readme
Daniel Vincent Grippi authored
117
fa947b1 minor changes
Daniel Vincent Grippi authored
118 ### Install required gems
d3b24f3 added installation of build tools
Daniel Vincent Grippi authored
119 To start the app server for the **first time**, Bundler needs to grab Diaspora's gem depencencies. To allow this, run `bundle install` from Diaspora's root directory.
fa947b1 minor changes
Daniel Vincent Grippi authored
120
121 It is important to run a bundle install every so often, in the event of a new gem dependency. We will make sure to make an announcement in the event of a gem change.
122
2c2cc9c atx-style headers
Daniel Vincent Grippi authored
123 ### Start Mongo
124 After installing the above, run `sudo mongod` from where mongo is installed to start mongo.
125
4d7d937 updates to readme
Daniel Vincent Grippi authored
126 Diaspora will **not run** unless mongo is running. Mongo will not run by default, and will need to be started every time you wish to use or run the test suite for Diaspora.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
127
2c2cc9c atx-style headers
Daniel Vincent Grippi authored
128 ### Run the app server
3de13d0 minor edit
Daniel Vincent Grippi authored
129 Once mongo is running and bundler has finished, run `bundle exec thin start` from the root Diaspora directory. This will start the app server in development mode[.](http://bit.ly/9mwtUw)
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
130
2c2cc9c atx-style headers
Daniel Vincent Grippi authored
131 ### Testing
132 Diaspora's test suite uses [rspec](http://rspec.info/), a behavior driven testing framework. In order to run the tests, run `bundle exec rspec spec`.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
133
ea0d0cb link to tracker and wishlist
Daniel Vincent Grippi authored
134 ## Resources
135
1f27c86 correct roadmap link & added bug tracker link
Daniel Vincent Grippi authored
136 We are maintaining a [public tracker project](http://www.pivotaltracker.com/projects/61641) and a [roadmap](https://github.com/diaspora/diaspora/wiki/Roadmap). Also, you can file [bug reports](https://github.com/diaspora/diaspora/issues) right here on github.
ea0d0cb link to tracker and wishlist
Daniel Vincent Grippi authored
137
138 Ongoing discussion:
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
139
e72b558 fixed links in readme. added description used in our blog.
Daniel Vincent Grippi authored
140 - [Diaspora Developer Google Group](http://groups.google.com/group/diaspora-dev)
141 - [Diaspora Discussion Google Group](http://groups.google.com/group/diaspora-discuss)
142 - [#diaspora-dev](irc://irc.freenode.net/#diaspora-dev)
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
143
e72b558 fixed links in readme. added description used in our blog.
Daniel Vincent Grippi authored
144 More general info and updates about the project can be found on our [blog](http://joindiaspora.com), [twitter](http://twitter.com/joindiaspora). Also, be sure to join the official [mailing list](http://http://eepurl.com/Vebk).
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
145
95169a2 added agpl license to readme
Daniel Vincent Grippi authored
146
2c2cc9c atx-style headers
Daniel Vincent Grippi authored
147 ## License
95169a2 added agpl license to readme
Daniel Vincent Grippi authored
148 Copyright 2010 Diaspora Inc.
149
150 Diaspora is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
151
152 Diaspora is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
153
154 You should have received a copy of the GNU Affero General Public License along with Diaspora. If not, see <http://www.gnu.org/licenses/>.
155
Something went wrong with that request. Please try again.