| app | ||
| autotest | ||
| config | ||
| db | ||
| doc | ||
| lib | ||
| public | ||
| script | ||
| spec | ||
| test | ||
| vendor/plugins | ||
| .gitignore | ||
| .pairs | ||
| .rspec | ||
| Capfile | ||
| config.ru | ||
| Gemfile | ||
| Gemfile.lock | ||
| GNU-AGPL-3.0 | ||
| Rakefile | ||
| README.md | ||
Diaspora
The privacy aware, personally controlled, do-it-all, open source social network.
Preparing your system
In order to run Diaspora for development, there are a few external dependencies in getting your environment set up:
- Ruby - The Ruby programming language. (We're using 1.8. Comes preinstalled on Mac OS X.)
- MongoDB - A snappy noSQL database.
- OpenSSL - An encryption implementation. (Comes preinstalled on Mac OS X and later versions of Ubuntu.)
- ImageMagick - An Image processing library used to resize uploaded photos.
- Git - The fast version controll system.
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; and if you're using Debian, just use Synaptic (it comes pre-installed).
After you have Ruby installed on your system, you will need to get Bundler.
- Bundler - Gem management tool for Ruby projects.
Getting Diaspora
To download Diaspora, you will want to clone it from the official github repository here. If you have never used github before, their help desk has a pretty awesome guide on getting setup.
Running Diaspora
After installing the above, run the following command from where mongo is installed to start mongo. sudo mongod 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.
In order to start the app server for the first time, bundler needs to grab Diaspora's gem depencencies. To allow this, run the following command from Diaspora's root directory.
bundle install
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.
Once mongo is running and bundler has finished, run: bundle exec thin start This will start the app server in development mode.
Diaspora's test suite uses rspec, a behavior driven testing framework. In order to run the tests, run the following command: bundle exec rspec spec
Getting Help
There are multiple outlets of ongoing discussion on the development of Diaspora.
More general info and updates about the project can be found on our blog, twitter. Also, be sure to join the official mailing list.
License
Copyright 2010 Diaspora Inc.
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.
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.
You should have received a copy of the GNU Affero General Public License along with Diaspora. If not, see http://www.gnu.org/licenses/.