2020-01-01 22:37:59 +01:00
|
|
|
|
---
|
|
|
|
|
title: Code structure
|
2020-01-12 14:11:56 +01:00
|
|
|
|
description: Where to find certain parts of the codebase.
|
2020-01-01 22:37:59 +01:00
|
|
|
|
menu:
|
|
|
|
|
docs:
|
|
|
|
|
weight: 30
|
|
|
|
|
parent: dev
|
|
|
|
|
---
|
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
|
### Code structure {#structure}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
2023-12-07 20:46:29 +01:00
|
|
|
|
The following overview should not be seen as complete or authoritative but as a rough guidance to help you find your way in the application.
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
|
#### Ruby {#ruby}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
2022-11-20 07:34:38 +01:00
|
|
|
|
`app/controllers`
|
|
|
|
|
: Code that binds business logic to templates
|
|
|
|
|
|
|
|
|
|
`app/helpers`
|
|
|
|
|
: Code that can be used from views, i.e. common operations
|
|
|
|
|
|
|
|
|
|
`app/lib`
|
|
|
|
|
: Code that doesn’t fit in the other categories
|
|
|
|
|
|
|
|
|
|
`app/models`
|
|
|
|
|
: Representation of data entities and their associated methods
|
|
|
|
|
|
|
|
|
|
`app/policies`
|
|
|
|
|
: Permission checks and other validations, before calling related methods
|
|
|
|
|
|
|
|
|
|
`app/serializers`
|
|
|
|
|
: Code that generates JSON from models
|
|
|
|
|
|
|
|
|
|
`app/services`
|
|
|
|
|
: Complex logical operations involving multiple models
|
|
|
|
|
|
|
|
|
|
`app/views`
|
|
|
|
|
: Templates for generating HTML or other output
|
|
|
|
|
|
|
|
|
|
`app/workers`
|
|
|
|
|
: Code that executes outside the request-response cycle
|
|
|
|
|
|
|
|
|
|
`spec`
|
|
|
|
|
: Automated test suite
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
|
#### JavaScript {#javascript}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
2022-11-20 07:34:38 +01:00
|
|
|
|
`app/javascript/mastodon`
|
|
|
|
|
: Code for the frontend React.js application
|
|
|
|
|
|
|
|
|
|
`app/javascript/packs`
|
|
|
|
|
: Code for non-React.js pages
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
|
#### CSS and other assets {#assets}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
2022-11-20 07:34:38 +01:00
|
|
|
|
`app/javascript/images`
|
|
|
|
|
: Images
|
|
|
|
|
|
|
|
|
|
`app/javascript/styles`
|
|
|
|
|
: Code that turns into CSS via Sass
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
|
#### Localizations {#localizations}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
2022-11-20 07:34:38 +01:00
|
|
|
|
`config/locales`
|
|
|
|
|
: Server-side localizations in the YML format
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
2022-11-20 07:34:38 +01:00
|
|
|
|
`app/javascript/mastodon/locales`
|
|
|
|
|
: Client-side localizations in the JSON format
|
2020-01-01 22:37:59 +01:00
|
|
|
|
|
|
|
|
|
All locale files are normalized to ensure consistent formatting and key order, which minimizes changesets in version control.
|
|
|
|
|
|
2022-11-20 07:34:38 +01:00
|
|
|
|
- Run `bundle exec i18n-tasks normalize` to normalize server-side translations
|
2023-06-04 22:24:47 +02:00
|
|
|
|
- Run `yarn run i18n:extract` to extract and normalize client-side translations into `en.json`
|