闭社主体 forked from https://github.com/tootsuite/mastodon
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

85 lines
3.8 KiB

6 years ago
6 years ago
6 years ago
6 years ago
  1. ![Mastodon](https://i.imgur.com/NhZc40l.png)
  2. ========
  3. [![Build Status](https://img.shields.io/travis/tootsuite/mastodon.svg)][travis]
  4. [![Code Climate](https://img.shields.io/codeclimate/maintainability/tootsuite/mastodon.svg)][code_climate]
  5. [travis]: https://travis-ci.org/tootsuite/mastodon
  6. [code_climate]: https://codeclimate.com/github/tootsuite/mastodon
  7. Mastodon is a **free, open-source social network server** based on **open web protocols** like ActivityPub and OStatus. The social focus of the project is a viable decentralized alternative to commercial social media silos that returns the control of the content distribution channels to the people. The technical focus of the project is a good user interface, a clean REST API for 3rd party apps and robust anti-abuse tools.
  8. Click on the screenshot below to watch a demo of the UI:
  9. [![Screenshot](https://i.imgur.com/pG3Nnz3.jpg)][youtube_demo]
  10. [youtube_demo]: https://www.youtube.com/watch?v=YO1jQ8_rAMU
  11. **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.
  12. If you would like, you can [support the development of this project on Patreon][patreon]. Alternatively, you can donate to this BTC address: `17j2g7vpgHhLuXhN4bueZFCvdxxieyRVWd`
  13. [patreon]: https://www.patreon.com/user?u=619786
  14. ---
  15. ## Resources
  16. - [Frequently Asked Questions](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/FAQ.md)
  17. - [Use this tool to find Twitter friends on Mastodon](https://bridge.joinmastodon.org)
  18. - [API overview](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md)
  19. - [List of Mastodon instances](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md)
  20. - [List of apps](https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/Apps.md)
  21. - [List of sponsors](https://joinmastodon.org/sponsors)
  22. ## Features
  23. **No vendor lock-in: Fully interoperable with any conforming platform**
  24. It doesn't have to be Mastodon, whatever implements ActivityPub or OStatus is part of the social network!
  25. **Real-time timeline updates**
  26. See the updates of people you're following appear in real-time in the UI via WebSockets. There's a firehose view as well!
  27. **Federated thread resolving**
  28. 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
  29. **Media attachments like images and short videos**
  30. Upload and view images and WebM/MP4 videos attached to the updates. Videos with no audio track are treated like GIFs; normal videos are looped - like vines!
  31. **OAuth2 and a straightforward REST API**
  32. Mastodon acts as an OAuth2 provider so 3rd party apps can use the API
  33. **Fast response times**
  34. Mastodon tries to be as fast and responsive as possible, so all long-running tasks are delegated to background processing
  35. **Deployable via Docker**
  36. 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
  37. ---
  38. ## Development
  39. Please follow the [development guide](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Development-guide.md) from the documentation repository.
  40. ## Deployment
  41. There are guides in the documentation repository for [deploying on various platforms](https://github.com/tootsuite/documentation#running-mastodon).
  42. ## Contributing
  43. 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)
  44. **IRC channel**: #mastodon on irc.freenode.net
  45. ---
  46. ## Extra credits
  47. The elephant friend illustrations are created by [Dopatwo](https://mastodon.social/@dopatwo)