Your self-hosted, globally interconnected microblogging community
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
yhirano d63c291f86 Enable CodeClimate SCSS Lint checks (#2886)
* add scss_lint to Gemfile

* add .scss-lint.yml

* fix warnings of scss-lint

* chmod -x styles/variables.scss

* Enable CodeClimate SCSS Lint checks
8 years ago
app Enable CodeClimate SCSS Lint checks (#2886) 8 years ago
bin Replace sprockets/browserify with Webpack (#2617) 8 years ago
config Add final newline to locale files (#2890) 8 years ago
db Add effective index to subscriptions (#2885) 8 years ago
docs Fix redirect link on Tuning.md (#1595) 8 years ago
lib More robust PuSH subscription refreshes (#2799) 8 years ago
log
public Red favicon for dev (#2470) 8 years ago
spec Unblock domain service specs/refactor (#2867) 8 years ago
storybook Update storybook file autoload (#2057) 8 years ago
streaming namespace redis usage (#2869) 8 years ago
vendor/assets
.babelrc add asynchronous emojione-picker (code-splitting) (#2863) 8 years ago
.buildpacks Install nodejs before ruby 8 years ago
.codeclimate.yml Enable CodeClimate SCSS Lint checks (#2886) 8 years ago
.dockerignore Add postgres/redis folder to .dockerignore (#2659) 8 years ago
.editorconfig Add final newline to locale files (#2890) 8 years ago
.env.production.sample Add additional documentation and warnings to the WEB_DOMAIN setting. (#2386) 8 years ago
.env.test Add recovery code support for two-factor auth (#1773) 8 years ago
.env.vagrant Add a default LOCAL_DOMAIN=mastodon.dev to .env.vagrant 8 years ago
.eslintignore Dev Tooling fixes (eslint/editorconfig) (#1398) 8 years ago
.eslintrc.yml Eslintrc fix (#2850) 8 years ago
.foreman Replace sprockets/browserify with Webpack (#2617) 8 years ago
.gitignore Streamline javascript translation by improving translationRunner (#2808) 8 years ago
.nvmrc update Node to 6.x LTS (#1228) 8 years ago
.postcssrc.yml Replace sprockets/browserify with Webpack (#2617) 8 years ago
.rspec
.rubocop.yml Fix Rubocop offences (#2630) 8 years ago
.ruby-version Version bumps for ruby and misc gems (#1159) 8 years ago
.scss-lint.yml Enable CodeClimate SCSS Lint checks (#2886) 8 years ago
.slugignore Updates slugignore. 8 years ago
.travis.yml Minor fix in Travis config with bundler call (#2806) 8 years ago
CONTRIBUTING.md README tidy up (#2026) 8 years ago
Capfile remove capistrano/faster_assets from Capfile (#2737) 8 years ago
Dockerfile Replace sprockets/browserify with Webpack (#2617) 8 years ago
Gemfile Enable CodeClimate SCSS Lint checks (#2886) 8 years ago
Gemfile.lock Enable CodeClimate SCSS Lint checks (#2886) 8 years ago
ISSUE_TEMPLATE.md Adds note for instance admins. (#1925) 8 years ago
LICENSE
Procfile More robust PuSH subscription refreshes (#2799) 8 years ago
Procfile.dev More robust PuSH subscription refreshes (#2799) 8 years ago
README.md Fixes #1830 adds link to development guide (#2783) 8 years ago
Rakefile
Vagrantfile changed to run foreman with vagrant (#2742) 8 years ago
app.json More SMTP customization (#1372) 8 years ago
config.ru
docker-compose.yml Switch docker-compose to version 3. (#2747) 8 years ago
package.json Remove local_time gem, and add similar (#2875) 8 years ago
scalingo.json More SMTP customization (#1372) 8 years ago
yarn.lock Remove local_time gem, and add similar (#2875) 8 years ago

README.md

Mastodon

Build Status Code Climate

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.

An alternative implementation of the GNU social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.

Click on the screenshot to watch a demo of the UI:

Screenshot

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.

If you would like, you can support the development of this project on Patreon. Alternatively, you can donate to this BTC address: 17j2g7vpgHhLuXhN4bueZFCvdxxieyRVWd

Resources

Features

  • Fully interoperable with GNU social and any OStatus platform Whatever implements Atom feeds, ActivityStreams, Salmon, PubSubHubbub and Webfinger is part of the network
  • Real-time timeline updates See the updates of people you're following appear in real-time in the UI via WebSockets
  • Federated thread resolving 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
  • Media attachments like images and WebM Upload and view images and WebM videos attached to the updates
  • OAuth2 and a straightforward REST API Mastodon acts as an OAuth2 provider so 3rd party apps can use the API, which is RESTful and simple
  • Background processing for long-running tasks Mastodon tries to be as fast and responsive as possible, so all long-running tasks that can be delegated to background processing, are
  • Deployable via Docker 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

Development

Please follow the development guide from the documentation repository.

Deployment

There are guides in the documentation repository for deploying on various platforms.

Contributing

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

IRC channel: #mastodon on irc.freenode.net

Extra credits

  • The Emoji One pack has been used for the emojis
  • The error page image courtesy of Dopatwo

Mastodon error image