Upstream README.md

Additional and/or changed features

Toot

• Toot length limit is increase to 5000 characters

User interfaces

• Add Slack like user interfaces
• Spoiler message preset
• Side navigation in right side or left side on phone
• Show relative time or absolute time in toot timeline
• Toot button position on phone
• Plain text or render GitHub Flavored Markdown (experimental)
• Preview search box by Misskey Flavored Markdown
• Show original post link in toot timeline

Server

• Configurable use Cloudflare Turnstile at signup
  • CLOUDFLARE_TURNSTILE_ENABLED=true
  • CLOUDFLARE_TURNSTILE_SITE_KEY=1x00000000000000000000AA
  • CLOUDFLARE_TURNSTILE_SECRET_KEY=1x0000000000000000000000000000000AA
• Configurable enable or disable signup by REST API
  • DISABLE_SIGNUP_BY_API=true
• Configurable enable or disable remote media cache
  • DISABLE_REMOTE_MEDIA_CACHE=true

Start develop

Before developing, you need to install the following software.

• Ruby 3.0.x
• Node.js 16.x
• Yarn 1.22.x

Then run the following commands.

yarn docker:dev up -d
bundle install
cp .env.sample .env
rails db:migrate
yarn watch

License

Copyright (C) 2016-2023 Eugen Rochko & other Mastodon contributors (see AUTHORS.md)

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.

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.

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/.