README.md 3.01 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
[![Build Status](https://secure.travis-ci.org/diaspora/diaspora.png?branch=master)](http://travis-ci.org/diaspora/diaspora)
6
[![Dependency Status](https://gemnasium.com/diaspora/diaspora.png?travis)](https://gemnasium.com/diaspora/diaspora)
Bryan Helmkamp's avatar
Bryan Helmkamp committed
7
[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/diaspora/diaspora)
ilya's avatar
ilya committed
8

9 10 11 12 13
************************
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
************************

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

16 17 18
- Make cool stuff
- Share it across the web
- Own your own data
Raphael's avatar
Raphael committed
19

Sean Tilley's avatar
Sean Tilley committed
20

21
## Quick Start:
Raphael's avatar
Raphael committed
22

23 24
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).
25

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

zhitomirskiyi's avatar
zhitomirskiyi committed
31

32
### Step 2: Run the development server
33
```
34 35 36 37
  rails s
```

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

39
### Step 3 (for developers): Run tests
40 41
```
  rake
42
```
43

Dennis Collinson's avatar
Dennis Collinson committed
44 45 46
### Step 4 (for everyone): Party.


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

## Contributing
51 52 53
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.
54 55 56

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

57 58
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#)

59 60 61
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:
62

63 64 65 66 67
- [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)
68
- [IRC](https://github.com/diaspora/diaspora/wiki/How-we-use-IRC)