mirror of
https://github.com/mastodon/documentation
synced 2025-04-11 22:56:17 +02:00
ffbe66a389
* fix relrefs around trends and related entities * revert moving caption-links to middle of page * hide empty menu in table of contents * clarify edit notifs are only for boosted statuses * following/followers no longer need auth * fix typo * specify cooldown period for account Move * use the correct cooldown * add missing parameters to accounts/id/statuses * link to account_statuses_filter.rb * fix typo (#1072) * fix typo (#1073) * fix link to http sig spec (#1067) * simply HTTP request examples in api methods docs * add missing client_secret to oauth/token (#1062) * Add any, all, none to hashtag timeline * minor formatting changes * Update signature requirements and advice * fix public key -> private key * clarify use of RSA with SHA256 * Add note about saving your profile after adding rel-me link * v2 filters api * comment out params that shouldn't be used in v2 filter api * admin trends * remove old todo * canonical email blocks + scheduled statuses * remove under-construction warnings from finished pages * verify api method params with source code * fix typo (#1088) * fix broken caption-links (#1100) * fix formatting of entities (#1094) * Remove keybase section from user guide (#1093) * fix typos (#1092) * Verify limits are accurate (#1086) * add mention of iframe limitation (#1084) * Add CORS header to WEB_DOMAIN example (#1083) * Fix typo (#1081) * pin http sigs spec at draft 8 * Revert "pin http sigs spec at draft 8" This reverts commit 9fd5f7032b69b29e77599dd62adfe8d2f5cd4f20. * add case sensitivity warning to 4.0 roles * Add url length note to bio (#1087) * remove follow scope from examples (#1103) * clarify usage of update_credentials to update profile fields * add noindex to Account entitity * remove required hint from technically not required property
75 lines
1.7 KiB
Markdown
75 lines
1.7 KiB
Markdown
---
|
||
title: Code structure
|
||
description: Where to find certain parts of the codebase.
|
||
menu:
|
||
docs:
|
||
weight: 30
|
||
parent: dev
|
||
---
|
||
|
||
### Code structure {#structure}
|
||
|
||
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.
|
||
|
||
#### Ruby {#ruby}
|
||
|
||
`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
|
||
|
||
#### JavaScript {#javascript}
|
||
|
||
`app/javascript/mastodon`
|
||
: Code for the frontend React.js application
|
||
|
||
`app/javascript/packs`
|
||
: Code for non-React.js pages
|
||
|
||
#### CSS and other assets {#assets}
|
||
|
||
`app/javascript/images`
|
||
: Images
|
||
|
||
`app/javascript/styles`
|
||
: Code that turns into CSS via Sass
|
||
|
||
#### Localizations {#localizations}
|
||
|
||
`config/locales`
|
||
: Server-side localizations in the YML format
|
||
|
||
`app/javascript/mastodon/locales`
|
||
: Client-side localizations in the JSON format
|
||
|
||
All locale files are normalized to ensure consistent formatting and key order, which minimizes changesets in version control.
|
||
|
||
- Run `bundle exec i18n-tasks normalize` to normalize server-side translations
|
||
- Run `yarn run manage:translations` to normalize client-side translations
|
||
|