aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.17.0/07-Development/02-directories.md
diff options
context:
space:
mode:
authorMohamedBassem <me@mbassem.com>2024-09-22 16:33:06 +0000
committerMohamedBassem <me@mbassem.com>2024-09-22 16:33:06 +0000
commitfb0336b55452157f62fed4b4ebfe5ce72d55a48b (patch)
tree3ed94b6293f8ab2dcd990083d2ef9aee1b845bc9 /docs/versioned_docs/version-v0.17.0/07-Development/02-directories.md
parent4272712ae82a0b5a5f50a96f0661c36a1f951651 (diff)
downloadkarakeep-fb0336b55452157f62fed4b4ebfe5ce72d55a48b.tar.zst
docs: Release the 0.17 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.17.0/07-Development/02-directories.md')
-rw-r--r--docs/versioned_docs/version-v0.17.0/07-Development/02-directories.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.17.0/07-Development/02-directories.md b/docs/versioned_docs/version-v0.17.0/07-Development/02-directories.md
new file mode 100644
index 00000000..54552402
--- /dev/null
+++ b/docs/versioned_docs/version-v0.17.0/07-Development/02-directories.md
@@ -0,0 +1,28 @@
+# Directory Structure
+
+## Apps
+
+| Directory | Description |
+| ------------------------ | ------------------------------------------------------ |
+| `apps/web` | The main web app |
+| `apps/workers` | The background workers logic |
+| `apps/mobile` | The react native based mobile app |
+| `apps/browser-extension` | The browser extension |
+| `apps/landing` | The landing page of [hoarder.app](https://hoarder.app) |
+
+## Shared Packages
+
+| Directory | Description |
+| ----------------- | ---------------------------------------------------------------------------- |
+| `packages/db` | The database schema and migrations |
+| `packages/trpc` | Where most of the business logic lies built as TRPC routes |
+| `packages/shared` | Some shared code between the different apps (e.g. loggers, configs, assetdb) |
+
+## Toolings
+
+| Directory | Description |
+| -------------------- | ----------------------- |
+| `tooling/typescript` | The shared tsconfigs |
+| `tooling/eslint` | ESlint configs |
+| `tooling/prettier` | Prettier configs |
+| `tooling/tailwind` | Shared tailwind configs |