diaspora/README.md
2013-06-12 22:26:16 -05:00

61 lines
2.5 KiB
Markdown

Diaspora*
Diaspora is a privacy-aware, personally-controlled, do-it-all open source social network. Check out our [project site](http://diasporafoundation.org).
* **master:** [![Build Status master](https://secure.travis-ci.org/diaspora/diaspora.png?branch=master)](http://travis-ci.org/diaspora/diaspora)
* **develop:** [![Build Status develop](https://secure.travis-ci.org/diaspora/diaspora.png?branch=develop)](http://travis-ci.org/diaspora/diaspora)
* [![Dependency Status](https://gemnasium.com/diaspora/diaspora.png?travis)](https://gemnasium.com/diaspora/diaspora)
* [![Code Climate](https://codeclimate.com/github/diaspora/diaspora.png)](https://codeclimate.com/github/diaspora/diaspora)
With Diaspora you can:
- Make cool stuff
- Share it across the web
- Own your own data
## Quick Start:
Here's how you can get a **[development](http://guides.rubyonrails.org/getting_started.html)** environment up and running. This is where any new pod runner should start, as well as people
looking to contribute to D*. This script assumes you have [a basic Rails setup installed](http://railsapps.github.com/installing-rails-3-1.html).
### Step 1: Run the script and follow the on screen instructions.
```
bash <(curl https://raw.github.com/diaspora/diaspora/master/script/install.sh)
```
### Step 2: Run the development server
```
rails s
```
then visit 'http://localhost:3000' in your browser.
### Step 3 (for developers): Run tests
```
rake
```
### Step 4 (for everyone): Party.
### Want a production setup? Having trouble with install script? Want to install D* the slow way?
Look to more specific install guides [here](http://wiki.diasporafoundation.org/Installation_guides).
## Contributing
We love community contributions, and we work extra hard to make sure every code contribution is looked at and given feedback.
To help everyone involved, please review our [Pull Request Guidelines](http://wiki.diasporafoundation.org/Pull_Request_Guidelines)
to make sure all contributions are submitted smoothly.
Documentation is available on our [wiki](http://wiki.diasporafoundation.org)
## More Resources:
- [Wiki](http://wiki.diasporafoundation.org)
- [Podmin Resources](https://github.com/diaspora/diaspora/wiki/Podmin-Resources)
- [Contributing](https://github.com/diaspora/diaspora/wiki/Getting-Started-With-Contributing)
- [Dev List](https://groups.google.com/forum/?fromgroups#!forum/diaspora-dev)
- [Discuss List](https://groups.google.com/forum/?fromgroups#!forum/diaspora-discuss)
- [IRC](http://wiki.diasporafoundation.org/How_We_Communicate#IRC)