docs: add Project Structure section to CONTRIBUTING.md

ArtalkJS · Jan 23, 2023 · 958d390 · 958d390
1 parent 7de6c27
commit 958d390
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -70,6 +70,22 @@ email: "[email protected]"
 password: "admin"
 ```
 
+## Project Structure
+
+Artalk is a monorepo project, which means all the source code is in the same repository. However, the frontend and backend are separated. The frontend part is located in `./ui` directory.
+
+- `bin/` - The compiled binary files. This directory is ignored by git.
+- `cmd/` - The source code for the command line tools.
+- `conf/` - The sample configuration files.
+- `docs/` - The documentation site source code.
+- `i18n/` - The translation files.
+- `internal/` - The internal packages.
+- `local/` - The local example site. This directory is ignored by git.
+- `public/` - The static files. Built frontend files will be copied here.
+- `scripts/` - The scripts for development.
+- `server/` - The source code for the server.
+- `ui/` - The source code for the frontend.
+
 ## Translation
 
 Artalk aims to be a multilingual project. If you would like to contribute to the translation, here are some tips: