闭社主体 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.

98 lines
4.5 KiB

7 years ago
8 years ago
8 years ago
8 years ago
8 years ago
  1. ![Mastodon](https://i.imgur.com/NhZc40l.png)
  2. ========
  3. [![Build Status](https://img.shields.io/circleci/project/github/tootsuite/mastodon.svg)][circleci]
  4. [![Code Climate](https://img.shields.io/codeclimate/maintainability/tootsuite/mastodon.svg)][code_climate]
  5. [![Translation status](https://weblate.joinmastodon.org/widgets/mastodon/-/svg-badge.svg)][weblate]
  6. [circleci]: https://circleci.com/gh/tootsuite/mastodon
  7. [code_climate]: https://codeclimate.com/github/tootsuite/mastodon
  8. [weblate]: https://weblate.joinmastodon.org/engage/mastodon/
  9. 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.
  10. Click on the screenshot below to watch a demo of the UI:
  11. [![Screenshot](https://i.imgur.com/qrNOiSp.png)][youtube_demo]
  12. [youtube_demo]: https://www.youtube.com/watch?v=IPSbNdBmWKE
  13. **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.
  14. If you would like, you can [support the development of this project on Patreon][patreon].
  15. [patreon]: https://www.patreon.com/mastodon
  16. ---
  17. ## Resources
  18. - [Quick start guide](https://blog.joinmastodon.org/2018/08/mastodon-quick-start-guide/)
  19. - [Find Twitter friends on Mastodon](https://bridge.joinmastodon.org)
  20. - [API overview](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md)
  21. - [Documentation](https://github.com/tootsuite/documentation)
  22. - [List of servers](https://joinmastodon.org/#getting-started)
  23. - [List of apps](https://joinmastodon.org/apps)
  24. - [List of sponsors](https://joinmastodon.org/sponsors)
  25. ## Features
  26. **No vendor lock-in: Fully interoperable with any conforming platform**
  27. It doesn't have to be Mastodon, whatever implements ActivityPub or OStatus is part of the social network!
  28. **Real-time timeline updates**
  29. See the updates of people you're following appear in real-time in the UI via WebSockets. There's a firehose view as well!
  30. **Federated thread resolving**
  31. 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
  32. **Media attachments like images and short videos**
  33. 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!
  34. **OAuth2 and a straightforward REST API**
  35. Mastodon acts as an OAuth2 provider so 3rd party apps can use the API
  36. **Fast response times**
  37. Mastodon tries to be as fast and responsive as possible, so all long-running tasks are delegated to background processing
  38. **Deployable via Docker**
  39. 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
  40. ---
  41. ## Development
  42. Please follow the [development guide](https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Development-guide.md) from the documentation repository.
  43. ## Deployment
  44. There are guides in the documentation repository for [deploying on various platforms](https://github.com/tootsuite/documentation#running-mastodon).
  45. ## Contributing
  46. 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)
  47. **IRC channel**: #mastodon on irc.freenode.net
  48. ## License
  49. Copyright (C) 2016-2018 Eugen Rochko & other Mastodon contributors (see AUTHORS.md)
  50. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  51. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
  52. You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
  53. ---
  54. ## Extra credits
  55. The elephant friend illustrations are created by [Dopatwo](https://mastodon.social/@dopatwo)