README.md 2.21 KB
Newer Older
1
## Welcome to the Diaspora Project!
2

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

[![Build Status](https://secure.travis-ci.org/diaspora/diaspora.png)](http://travis-ci.org/diaspora/diaspora)
[![Dependency Status](https://gemnasium.com/diaspora/diaspora.png?travis)](https://gemnasium.com/diaspora/diaspora)
ilya's avatar
ilya committed
7

8 9 10 11 12
************************
Diaspora is currently going through a huge refactoring push, the code is changing fast!
If you want to do something big, reach out on IRC or the mailing list first, so you can contribute effectively <3333
************************

13
With Diaspora you can:
Sean Tilley's avatar
Sean Tilley committed
14

15 16 17
- Run and host your own pod and have control over your own social experience.
- Own your own data.
- Make friends across other pods seamlessly.
Raphael's avatar
Raphael committed
18

19
Documentation is available on our [wiki](https://github.com/diaspora/diaspora/wiki)
Raphael's avatar
Raphael committed
20

Sean Tilley's avatar
Sean Tilley committed
21
[Pull Request Guidelines](https://github.com/diaspora/diaspora/wiki/Pull-Request-Guidelines)
Sean Tilley's avatar
Sean Tilley committed
22

Sean Tilley's avatar
Sean Tilley committed
23 24
Before submitting code, feel free to 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)

25
## Quick Start:
Raphael's avatar
Raphael committed
26

27
Here's how you can get a development environment up and running. You can check out system-specific guides [here](https://github.com/diaspora/diaspora/wiki/Installation-Guides).
Raphael's avatar
Raphael committed
28

29
### Step 1: Download the script
30 31
```
  curl https://raw.github.com/diaspora/diaspora/master/script/install.sh | /bin/sh
32
```
33

Maxwell Salzberg's avatar
Maxwell Salzberg committed
34
### Step 2: Follow the instructions
zhitomirskiyi's avatar
zhitomirskiyi committed
35

36

Maxwell Salzberg's avatar
Maxwell Salzberg committed
37
### Step 3: Run the the development server
38
```
39 40 41 42
  rails s
```

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

Maxwell Salzberg's avatar
Maxwell Salzberg committed
44
### Step 4: Run tests
45 46
```
  rake
47
```
48

49
## Resources:
50

51 52 53 54 55
- [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)
56
- [IRC](https://github.com/diaspora/diaspora/wiki/How-we-use-IRC)