diaspora/README.md

56 lines
No EOL
2.2 KiB
Markdown

## Welcome to the Diaspora Project!
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)
************************
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
************************
With Diaspora you can:
- Run and host your own pod and have control over your own social experience.
- Own your own data.
- Make friends across other pods seamlessly.
Documentation is available on our [wiki](https://github.com/diaspora/diaspora/wiki)
[Pull Request Guidelines](https://github.com/diaspora/diaspora/wiki/Pull-Request-Guidelines)
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)
## Quick Start:
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).
### Step 1: Download the script
```
curl https://raw.github.com/diaspora/diaspora/master/script/install.sh | /bin/sh
```
### Step 2: Follow the instructions
### Step 3: Run the the development server
```
rails s
```
then visit 'http://localhost:3000' in your browser.
### Step 4: Run tests
```
rake
```
## Resources:
- [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)
- [IRC](https://github.com/diaspora/diaspora/wiki/How-we-use-IRC)