Giter Club home page Giter Club logo

joinmastodon's Introduction

joinmastodon.org

This repository contains the source for joinmastodon.org, the informational site and landing portal for the Mastodon project.

You can submit translations via Crowdin (note: you will need to be logged-in to Crowdin for the link to work correctly). Read more below.

Development

To build and run the site locally, you'll need to have Node.js version 20 installed, which you can download from the Node.js website or install via tools like fnm or nvm. For dependency management, yarn is used, it should be automatically be installed when you install Node.js, if it's not available you can use corepack enable and corepack prepare yarn@1 to install it.

Installation

yarn
yarn run dev

See package.json for more scripts.

Contributing

See CONTRIBUTING for more information. All interactions with this and other repositories that are part of the Mastodon project are subject to the Mastodon Code of Conduct.

Built with

Translations

Translations are managed via Crowdin and distributed with react-intl. Submit translations at Crowdin. Note that you will need to be logged-in to an account on the Crowdin website for the link to the project to work correctly. The project will not accept translations submitted via other means, as they would fall outside of the workflow described below.

The basic translation workflow is:

  1. Translatable messages are declared in the source files using the <FormattedMessage> component.
  2. Default messages are extracted to locales/en.json by running yarn extract.
  3. The locale files are synced with the Crowdin project. Any new messages in the source file(locales/en.json) are made available for translation for other languages. Any new translated messages are downloaded back to the repo into corresponding locale files (e.g. locales/es.json).
  4. On build, each locale loads its corresponding messages from getStaticProps() (example).

Internationalized Routing

Localized versions of each page are hosted at dedicated URLs, making it easier for web crawling in users' preferred language. (docs)

Image optimization

Raster images should be added at the maximum resolution they'll be displayed at. If art direction is not required, mobile images will be generated automatically. (docs)

Deployment

Next.js should be hosted using a Node.js server. (see instructions). The reasons that this has been chosen over a static HTML export are:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.