README.md 2.93 KB
Newer Older
1
Diaspora*
2

3 4
Diaspora is a privacy-aware, personally-controlled, do-it-all open source social network. Check out our [project site](http://diasporaproject.org).

5 6 7 8 9
* **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/badge.png)](https://codeclimate.com/github/diaspora/diaspora)

10

11
With Diaspora you can:
Sean Tilley's avatar
Sean Tilley committed
12

13 14 15
- Make cool stuff
- Share it across the web
- Own your own data
Raphael's avatar
Raphael committed
16

17

18
## Quick Start:
Raphael's avatar
Raphael committed
19

20 21
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).
22

23
### Step 1: Run the script and follow the on screen instructions.
24
```
25
  bash <(curl https://raw.github.com/diaspora/diaspora/master/script/install.sh)
26
```
27

zhitomirskiyi's avatar
zhitomirskiyi committed
28

29
### Step 2: Run the development server
30
```
31 32 33 34
  rails s
```

then visit 'http://localhost:3000' in your browser.
35

36
### Step 3 (for developers): Run tests
37 38
```
  rake
39
```
40

Dennis Collinson's avatar
Dennis Collinson committed
41 42 43
### Step 4 (for everyone): Party.


44
### Want a production setup? Having trouble with install script? Want to install D* the slow way?
45 46 47
  Look to more specific install guides [here](https://github.com/diaspora/diaspora/wiki/Installation-Guides).

## Contributing
48 49 50
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](https://github.com/diaspora/diaspora/wiki/Pull-Request-Guidelines)
to make sure all contributions are submitted smoothly.
51 52 53

Documentation is available on our [wiki](https://github.com/diaspora/diaspora/wiki)

54 55
Also, feel free to jump in and check things that need to be done in our [Community Pivotal Tracker](https://www.pivotaltracker.com/projects/61641#)

56 57 58
Before submitting code, please sign our [Contributor License Agreement](https://github.com/diaspora/diaspora/wiki/New-CLA--12-13-10) [Sign Here](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ)

## More Resources:
59

60 61 62 63 64
- [Wiki](https://github.com/diaspora/diaspora/wiki)
- [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)
65
- [IRC](https://github.com/diaspora/diaspora/wiki/How-we-use-IRC)