From 8fccea5fe142e4ca172ce13c96c704c0b04a567b Mon Sep 17 00:00:00 2001
From: Arman <arman@appwrite.io>
Date: Thu, 11 May 2023 12:35:33 +0200
Subject: [PATCH] chore: update contribution repo structure

---
 CONTRIBUTING.md | 46 +++++++++++++++++++++++++++-------------------
 1 file changed, 27 insertions(+), 19 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 607bb07f6..60baa93de 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -10,25 +10,30 @@ If you are worried about or don’t know where to start, check out the next sect
 
 ```
 ├── src
-│   ├── lib                             // All non-route components, accessible over "import ... from '$lib'"
-│   │   ├── components                  // Re-usable components
-│   │   ├── elements                    // Re-usable elements
-│   │   ├── layout                      // Global components for the layout (Nav/Content/Container)
-│   │   └── stores                      // Global stores (state management)
-│   └─── routes
-│       ├── console                     // Routes that need authentication
-│       │   ├──[project]
-│       │   │   ├── database            // Database Service
-│       │   │   │   ├── [collection]    // Nested Route for the collection "/console/[PROJECT_ID]/database/[COLLECTION_ID]"
-│       │   │   │   ├── _create.svelte  // Component to Create collections
-│       │   │   │   └── index.svelte    // Entrypoint for "/console/[PROJECT_ID]/database"
-│       │   │   ├── storage             // Storage Service "/console/[PROJECT]/storage"
-│       │   │   └── auth                // Users Service "/console/[PROJECT]/auth"
-│       │   └──...
-│       ├── login.svelte                // Component for Login "/console/login"
-│       └── register.svelte             // Component for Register "/console/register"
-├── build // Compiled application
-└── static // Static assets
+│   ├── lib                                       // Reusable logic (accessible with '$lib')
+│   │   ├── actions                               // Svelte actions
+│   │   ├── charts                                // Chart components
+│   │   ├── components                            // Re-usable components
+│   │   ├── elements                              // Re-usable elements
+│   │   ├── helpers                               // Small functions used through out the console
+│   │   ├── images                                // Images used in the console
+│   │   ├── layout                                // Global components for the layout (Nav/Content/Container)
+│   │   ├── mock                                  // Mock components used for testing
+│   │   └── stores                                // Global stores (state management)
+│   └── routes
+│       └── console                               // Routes that need authentication
+│       │   └── project-[project]
+│       │   │   └── database                      // Database Service
+│       │   │   │   ├── +layout.svelte            // Layout head and other logic like realtime events is set here
+│       │   │   │   ├── +layout.ts                // Layout data is set here (Header, Breadcrumbs, ...)
+│       │   │   │   ├── +page.svelte              // Page displayed on "/console/project-[PROJECT_ID]/database"
+│       │   │   │   ├── +page.ts                  // Necessary data for the page is fetched here
+│       │   │   │   └── create.svelte             // Component to create databases
+│       │   │   └── ...                           // Other services
+│       │   └── ...
+│       └── ...                                   // Routes that don't need authentication
+├── build                                         // Compiled application
+└── static                                        // Static assets
 ```
 
 ## Development
@@ -40,12 +45,15 @@ git clone https://github.com/appwrite/console.git appwrite-console
 ```
 
 ### 2. Install dependencies with npm
+
 Navigate to the Appwrite Console repository and install dependencies.
+
 ```bash
 cd appwrite-console && npm install
 ```
 
 ### 3. Install and run Appwrite locally
+
 When you run the Appwrite Console locally, it needs to point to a backend as well. The easiest way to do this is to run an Appwrite instance locally.
 
 Follow the [install instructions](https://appwrite.io/docs/installation) in the Appwrite docs.