mirror of
https://github.com/mastodon/mastodon.git
synced 2025-01-20 22:08:27 +01:00
Add codebase structure to README.md
This commit is contained in:
parent
f5a70987cf
commit
7aa12f6802
1 changed files with 18 additions and 0 deletions
18
README.md
18
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.
|
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
|
## 🛠️ Building from source
|
||||||
|
|
||||||
### 🔤 Vagrant
|
### 🔤 Vagrant
|
||||||
|
|
Loading…
Reference in a new issue