gnh1201/mastodon
1
0
Fork 0
mirror of https://github.com/mastodon/mastodon.git synced 2024-11-26 15:31:52 +00:00
Code Issues Actions 14 Packages Projects Releases Wiki Activity

📝 Add codebase structure to README.md

Browse Source
This commit is contained in:
Lamparter 2024-09-28 16:12:08 +01:00 committed by GitHub
parent 0a31f4531b
commit 34814d4bcc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -60,6 +60,24 @@ Mastodon is a **free, open-source social network server** based on ActivityPub w
The repository includes deployment configurations for **Docker and docker-compose** as well as specific platforms like **Heroku**, and **Scalingo**. For Helm charts, reference the [mastodon/chart repository](https://github.com/mastodon/chart). The [**standalone** installation guide](https://docs.joinmastodon.org/admin/install/) is available in the documentation.
### 🏗️ Codebase structure
```
├──.devcontainer // Scripts and preparation files for running Mastodon in a development container such as github.dev
├──.github // Health files for GitHub such as issue templates
├──app // Collection of code files relating to the app's frontend
├──bin // Scripts for running and hosting Mastodon
├──config // Code files relating to federated hosting and Ruby bootstrappers
├──db // Database files for Mastodon's information database (Host-specific backend)
├──dist // Collection of code files relating app hosting on domains and port relations
├──lib // Code and file library
├──log // Hosting logs (Host-specific backend; reserved for Mastodon hosting)
├──public // Static resource files
├──spec // Helpers, presenters, and other code models
├──streaming // (Host-specific backend; reserved for Mastodon hosting)
└──vendor // (Host-specific backend; reserved for Mastodon hosting)
```
## 🛠️ Building from source
### 🔤 Vagrant