aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.25.0/07-Development/02-directories.md
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-06-08 10:06:06 +0000
committerMohamed Bassem <me@mbassem.com>2025-06-08 10:06:06 +0000
commitdd38899cb6ef3284af94a25cfe1d3cfeb1238684 (patch)
tree5f62eeb1370499b2a3ba0948f13cd863bec04932 /docs/versioned_docs/version-v0.25.0/07-Development/02-directories.md
parentfc3e7b99e8a5d65fd363d5396ac52d9f24f45ab6 (diff)
downloadkarakeep-dd38899cb6ef3284af94a25cfe1d3cfeb1238684.tar.zst
docs: Release the 0.25.0 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.25.0/07-Development/02-directories.md')
-rw-r--r--docs/versioned_docs/version-v0.25.0/07-Development/02-directories.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.25.0/07-Development/02-directories.md b/docs/versioned_docs/version-v0.25.0/07-Development/02-directories.md
new file mode 100644
index 00000000..712e86a1
--- /dev/null
+++ b/docs/versioned_docs/version-v0.25.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 [karakeep.app](https://karakeep.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 |