nocebo/diaspora
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

minor changes

Browse source
This commit is contained in:
Daniel Vincent Grippi 2010-09-14 17:51:35 -07:00
parent fb9d504f29
commit fa947b1036
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -3,14 +3,14 @@
The privacy aware, personally controlled, do-it-all, open source social network.
**DISCLAIMER: THIS IS PRE-ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.**
These instructions are designed for developers running [Ubuntu](http://www.ubuntu.com/) (Debian) or Mac OS X.
These instructions are designed for machines running [Ubuntu](http://www.ubuntu.com/) or Mac OS X.
## Preparing your system
In order to run Diaspora, you will need to download the following dependencies (specific instructions follow):
- [Ruby](http://www.ruby-lang.org) - The Ruby programming language. (We're using 1.8. Comes preinstalled on Mac OS X.)
- [Ruby](http://www.ruby-lang.org) - The Ruby programming language. (We're using 1.8. It comes preinstalled on Mac OS X.)
- [MongoDB](http://www.mongodb.org) - A snappy noSQL database.
- [OpenSSL](http://www.openssl.org/) - An encryption implementation. (Comes preinstalled on Mac OS X and later versions of Ubuntu.)
- [OpenSSL](http://www.openssl.org/) - An encryption implementation. (It comes preinstalled on Mac OS X and later versions of Ubuntu.)
- [ImageMagick](http://www.imagemagick.org/) - An Image processing library used to resize uploaded photos.
- [Git](http://git-scm.com/) - The fast version controll system.
@ -19,7 +19,7 @@ After you have Ruby installed on your system, you will need to get Rubygems, the
- [RubyGems](http://rubygems.org/) - Source for Ruby gems.
- [Bundler](http://gembundler.com/) - Gem management tool for Ruby projects.
**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 (Debian), just use [Synaptic](http://www.nongnu.org/synaptic/) (it comes pre-installed). The below instructions assume you have these installed.**
**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 below instructions assume you have these installed.**
### Ruby
@ -55,6 +55,8 @@ If you're running either **Ubuntu** or **Mac OS X** you already have OpenSSL ins
To install ImageMagick on **Ubuntu**, run the following:
sudo apt-get install imagemagick libmagick9-dev
To install ImageMagick on **Mac OS X**, run the following:
brew install imagemagick
@ -94,18 +96,18 @@ To download Diaspora, you will want to clone it from the official github reposit
## Running Diaspora
### Install required gems
In order 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.
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.
### Start Mongo
After installing the above, run `sudo mongod` from where mongo is installed to start mongo.
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.
### Install required gems
In order 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.
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.
### Run the app server
Once mongo is running and bundler has finished, run `bundle exec thin start`. This will start the app server in development mode.
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.
### Testing
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`.