From 1693fef7081c9205477160b7e47dd26ec92360bb Mon Sep 17 00:00:00 2001
From: Wanjohi <71614375+wanjohiryan@users.noreply.github.com>
Date: Fri, 20 Sep 2024 14:43:09 +0300
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20feat:=20Add=20the=20`Project=20Stru?=
 =?UTF-8?q?cture`=20section=20to=20the=20Contributing.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 CODE_OF_CONDUCT.md | 58 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 57 insertions(+), 1 deletion(-)

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index 31c2f1c6..56618cfe 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -26,4 +26,60 @@ Examples of unacceptable behavior by participants include:
 
 Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate
\ No newline at end of file
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate
+
+## Project Structure
+
+Nestri is organized as a monorepo using Turborepo. Here's an overview of the main directories and their purposes:
+
+### Root Directory
+
+- `apps/`: Contains the main applications
+  - `www/`: The main Nestri website built with Qwik
+- `infra/`: Contains the relevant files to deploy the app using [SST](https://sst.dev)
+- `packages/`: Shared packages and configurations
+  - `api/`: Core API for Nestri
+  - `eslint-config/`: Shared ESLint configurations
+  - `typescript-config/`: Shared TypeScript configurations
+  - `ui/`: Shared UI components and styles
+
+### Key Files
+
+- `package.json`: Root package file defining workspaces and shared dev dependencies
+- `turbo.json`: Turborepo configuration
+- `LICENSE`: GNU Affero General Public License v3.0
+
+### Apps
+
+#### www (Nestri Website)
+
+This is the Nestri website hosted on Cloudflare Pages
+
+### Packages
+
+#### api (Nestri Core)
+
+The core API for Nestri, built with Hono and deployed to Cloudflare Workers.
+
+#### eslint-config
+
+Shared ESLint configurations for maintaining consistent code style across the project.
+
+#### typescript-config
+
+Shared TypeScript configurations to ensure consistent TypeScript settings across the project.
+
+#### ui
+
+Shared UI components and styles used across the Nestri project.
+
+### Infrastructure
+
+- `infra/`: Contains infrastructure-as-code files
+  - `www.ts`: Defines the deployment configuration for the Nestri website
+
+### Development
+
+When working on Nestri, you'll primarily be dealing with the `apps/www` directory for the main website and the various packages in the `packages/` directory for shared functionality.
+
+For more detailed information about each package or app, refer to their respective README files or package.json scripts.