README.md

   1 ![Mastodon](https://i.imgur.com/NhZc40l.png)
   2 ========
   3
   4 [![Build Status](http://img.shields.io/travis/tootsuite/mastodon.svg)][travis]
   5 [![Code Climate](https://img.shields.io/codeclimate/github/tootsuite/mastodon.svg)][code_climate]
   6
   7 [travis]: https://travis-ci.org/tootsuite/mastodon
   8 [code_climate]: https://codeclimate.com/github/tootsuite/mastodon
   9
  10 Mastodon is a free, open-source social network server. A decentralized solution to commercial platforms, it avoids the risks of a single company monopolizing your communication. Anyone can run Mastodon and participate in the social network seamlessly.
  11
  12 An alternative implementation of the GNU social project. Based on [ActivityStreams](https://en.wikipedia.org/wiki/Activity_Streams_(format)), [Webfinger](https://en.wikipedia.org/wiki/WebFinger), [WebSub](https://en.wikipedia.org/wiki/WebSub) and [Salmon](https://en.wikipedia.org/wiki/Salmon_(protocol)).
  13
  14 Click on the screenshot to watch a demo of the UI:
  15
  16 [![Screenshot](https://i.imgur.com/pG3Nnz3.jpg)][youtube_demo]
  17
  18 [youtube_demo]: https://www.youtube.com/watch?v=YO1jQ8_rAMU
  19
  20 The project focus is a clean REST API and a good user interface. Ruby on Rails is used for the back-end, while React.js and Redux are used for the dynamic front-end. A static front-end for public resources (profiles and statuses) is also provided.
  21
  22 If you would like, you can [support the development of this project on Patreon][patreon]. Alternatively, you can donate to this BTC address: `17j2g7vpgHhLuXhN4bueZFCvdxxieyRVWd`
  23
  24 [patreon]: https://www.patreon.com/user?u=619786
  25
  26 ## Resources
  27
  28 - [List of Mastodon instances](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md)
  29 - [Use this tool to find Twitter friends on Mastodon](https://mastodon-bridge.herokuapp.com)
  30 - [API overview](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md)
  31 - [Frequently Asked Questions](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/FAQ.md)
  32 - [List of apps](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/Apps.md)
  33
  34 ## Features
  35
  36 - **Fully interoperable with GNU social and any OStatus platform**
  37   Whatever implements Atom feeds, ActivityStreams, Salmon, WebSub and Webfinger is part of the network
  38 - **Real-time timeline updates**
  39   See the updates of people you're following appear in real-time in the UI via WebSockets
  40 - **Federated thread resolving**
  41   If someone you follow replies to a user unknown to the server, the server fetches the full thread so you can view it without leaving the UI
  42 - **Media attachments like images and WebM**
  43   Upload and view images and WebM videos attached to the updates
  44 - **OAuth2 and a straightforward REST API**
  45   Mastodon acts as an OAuth2 provider so 3rd party apps can use the API, which is RESTful and simple
  46 - **Background processing for long-running tasks**
  47   Mastodon tries to be as fast and responsive as possible, so all long-running tasks that can be delegated to background processing, are
  48 - **Deployable via Docker**
  49   You don't need to mess with dependencies and configuration if you want to try Mastodon, if you have Docker and Docker Compose the deployment is extremely easy
  50
  51 ## Development
  52
  53 Please follow the [development guide](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Development-guide.md) from the documentation repository.
  54
  55 ## Deployment
  56
  57 There are guides in the documentation repository for [deploying on various platforms](https://github.com/tootsuite/documentation#running-mastodon).
  58
  59 ## Contributing
  60
  61 You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. [Here are the guidelines for code contributions](CONTRIBUTING.md)
  62
  63 **IRC channel**: #mastodon on irc.freenode.net
  64
  65 ## Extra credits
  66
  67 - The [Emoji One](https://github.com/Ranks/emojione) pack has been used for the emojis
  68 - The error page image courtesy of [Dopatwo](https://www.youtube.com/user/dopatwo)
  69
  70 ![Mastodon error image](https://mastodon.social/oops.png)