From 34814d4bccff1f2cc5d1224cdeee11d47fc1a397 Mon Sep 17 00:00:00 2001 From: Lamparter Date: Sat, 28 Sep 2024 16:12:08 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20codebase=20structure=20to?= =?UTF-8?q?=20`README.md`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index b6fa54d737..7522336383 100644 --- a/README.md +++ b/README.md @@ -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