Add docs pages

Author: mxvsh

.vitepress/config.mts

@@ -5,22 +5,51 @@ export default defineConfig({
   title: 'Drivebase',
   description:
     'Next-generation cloud-agnostic file management application that empowers users to organize, upload, and access files across multiple cloud providers.',
-  base: '/docs/',
-  head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
+  head: [
+    ['link', { rel: 'icon', href: '/favicon.ico' }],
+    [
+      'script',
+      {
+        src: 'https://analytics.monawwar.io/script.js',
+        'data-website-id': '3def49a3-cbce-4f3b-acb4-bd46421e9a2b',
+      },
+    ],
+  ],
   themeConfig: {
-    // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' },
+      { text: 'Providers', link: '/providers' },
     ],
 
     sidebar: [
       {
-        text: 'Examples',
+        text: 'Getting Started',
+        items: [
+          { text: 'Introduction', link: '/docs/introduction' },
+          { text: 'How it works', link: '/docs/how-it-works' },
+          {
+            text: 'Quickstart',
+            link: '/docs/quick-start',
+          },
+          {
+            text: 'Providers',
+            link: '/docs/providers',
+          },
+        ],
+      },
+      {
+        text: 'Installation',
+        items: [
+          { text: 'Docker', link: '/docs/installation/docker' },
+          { text: 'Manual', link: '/docs/installation/manual' },
+        ],
+      },
+      {
+        text: 'Providers',
         items: [
-          { text: 'Getting Started', link: '/getting-started' },
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' },
+          { text: 'Google Drive', link: '/docs/providers/google-drive' },
+          { text: 'Dropbox', link: '/docs/providers/dropbox' },
+          { text: 'OneDrive', link: '/docs/providers/one-drive' },
         ],
       },
     ],

api-examples.md

@@ -0,0 +1,32 @@
+---
+outline: deep
+---
+
+# How it works
+
+
+## Overview
+
+Drivebase is a tool that allows you to manage your files across multiple cloud providers. It uses OAuth to authenticate with the cloud providers and then uses the cloud provider's API to upload, download, and delete files.
+
+::: info
+You use your own API keys to authenticate with the cloud providers. In this way, you are in control of your own data.
+And the data is stored in your own database.
+:::
+
+
+## Step 1: Connect to a cloud provider
+
+From the available providers, you select the one you want to connect to by entering the required credentials.
+After that, you add your account to Drivebase by clicking the "Add account" button. You will be redirected to the cloud provider's website to authorize Drivebase to access your files.
+
+You can check [this page](/docs/providers/) for a list of supported providers.
+
+## Step 2: Create a folder structure
+
+You create a folder structure on Drivebase and they are stored in the connected database.
+
+## Step 3: Upload files
+
+You can upload files to Drivebase by dragging and dropping them into the application or by using the upload button.
+Before the files are uploaded, you will be asked to select the provider you want to upload the files to.

docs/how-it-works.md

@@ -0,0 +1,67 @@
+---
+outline: deep
+---
+
+# Docker Installation
+
+You can run Drivebase using Docker on your local machine or on a server. This is the recommended way to run Drivebase.
+There are two ways to run Drivebase using Docker:
+
+1. Using Docker Compose
+2. Using Docker Run
+
+### Using Docker Compose
+
+Create a `docker-compose.yml` file and paste the following code into it:
+
+```yaml
+version: '3'
+
+services:
+  drivebase:
+    image: ghcr.io/drivebase/drivebase:latest
+    ports:
+      - 8000:8000
+    environment:
+      - DATABASE_URL=postgresql://postgres:postgres@postgres:5432/postgres
+      - AUTH_SECRET=your-secret-key
+    depends_on:
+      - postgres
+
+  postgres:
+    image: postgres:latest
+    environment:
+      - POSTGRES_PASSWORD=postgres
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+
+volumes:
+  postgres_data:
+```
+
+Then, run the following command to start the containers:
+
+```bash
+docker-compose up -d
+```
+
+You can now access Drivebase at `http://localhost:8000`.
+
+### Using Docker Run
+
+To run Drivebase using Docker Run, you need to create a `.env` file and a running PostgreSQL instance.
+
+Create a `.env` file and paste the following code into it:
+
+```bash
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/postgres
+AUTH_SECRET=your-secret-key
+```
+
+Then, run the following command to start the container:
+
+```bash
+docker run -d -p 8000:8000 --env-file .env ghcr.io/drivebase/drivebase:latest
+```
+
+You can now access Drivebase at `http://localhost:8000`.

docs/installation/docker.md

@@ -0,0 +1,48 @@
+---
+outline: deep
+---
+
+# Manual Installation
+
+You can install Drivebase manually on your local machine or on a server.
+
+## Prerequisites
+
+- Node.js (20+)
+- pnpm (9+)
+- PostgreSQL
+
+## Installation
+
+1. Clone the repository
+
+```bash
+git clone https://github.com/drivebase/drivebase.git
+```
+
+2. Install the dependencies
+
+```bash
+pnpm install
+```
+
+3. Create a `.env` file and paste the following code into it:
+
+```bash
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/postgres
+AUTH_SECRET=your-secret-key
+```
+
+4. Run the following command to migrate the database:
+
+```bash
+pnpm prisma migrate dev
+```
+
+5. And finally, run the following command to start the server:
+
+```bash
+pnpm nx run-many -t serve -p backend,frontend
+```
+
+You can now access Drivebase at `http://localhost:8000`.

docs/installation/manual.md

@@ -0,0 +1,24 @@
+---
+outline: deep
+---
+
+# Introduction
+
+Drivebase is a cloud-agnostic file management application. It allows you to manage your files across multiple cloud providers in your own folder structure.
+
+Imagine your digital life scattered across multiple clouds. Your family photos on **Google Drive**, work documents on **Dropbox**, creative projects on **OneDrive**, and archives on **Amazon S3**. Each with its own login, interface, folder structure, and pricing model.
+
+You've likely experienced this frustration:
+**"Where did I save that file again? Was it on Drive or Dropbox?"**
+
+This fragmentation creates real challenges:
+
+- **Mental Overhead**: Constantly switching between services and remembering where files are stored
+- **Organizational Chaos**: Maintaining different folder structures across multiple platforms
+- **Provider Lock-In**: The painful process of migrating when a provider changes pricing or policies
+- **Storage Inefficiency**: Paying for premium tiers on one service while having free space on another
+- **Inconsistent Experience**: Learning different interfaces, search capabilities, and sharing mechanics
+
+What if your files could live anywhere while appearing exactly where you want them in your own unified organizational system?
+
+This is the promise of Drivebase—a single folder structure you control, with the freedom to choose where each file physically resides. You decide the storage provider. You break free from cloud fragmentation.

docs/introduction.md

@@ -0,0 +1,51 @@
+---
+outline: deep
+---
+
+# Providers
+
+Drivebase currently supports the following providers:
+
+- [Google Drive](/docs/providers/google-drive.md)
+- [OneDrive](/docs/providers/onedrive.md)
+- [Dropbox](/docs/providers/dropbox.md)
+- [WebDAV](/docs/providers/webdav.md)
+
+
+## Adding a new provider
+
+To add a new provider, you need to create a new provider in the `shared/internal/src/providers/providers` directory. 
+
+All the OAuth providers implement the `OAuthProvider` interface.
+You can always refer to the existing providers to see how to implement a new one.
+
+Here is the interface of the `OAuthProvider` class:
+
+```typescript
+export interface OAuthProvider {
+  config: OAuthConfig;
+
+  // Authentication
+  getAuthUrl(state?: string): string;
+  getAccessToken(code: string): Promise<AuthToken>;
+  refreshAccessToken(refreshToken: string): Promise<AuthToken>;
+  setCredentials(credentials: Record<string, string>): Promise<void>;
+  getUserInfo(): Promise<UserInfo>;
+
+  // Drivebase folder
+  hasFolder(id: string): Promise<boolean>;
+  createDrivebaseFolder(): Promise<string>;
+
+  // File operations
+  uploadFile(folderId: string, file: Express.Multer.File): Promise<string>;
+  downloadFile(fileId: string): Promise<Readable>;
+  getFileMetadata(fileId: string): Promise<any>;
+  deleteFile(path: string): Promise<boolean>;
+}
+```
+
+## Pull Request
+
+When you are done implementing the new provider, please create a pull request and wait for it to be merged.
+
+

docs/providers.md

@@ -2,5 +2,4 @@
 outline: deep
 ---
 
-# Getting Started
-
+# Dropbox

getting-started.md docs/providers/dropbox.mdgetting-started.md renamed to docs/providers/dropbox.md

@@ -0,0 +1,5 @@
+---
+outline: deep
+---
+
+# Google Drive

docs/providers/google-drive.md

@@ -0,0 +1,5 @@
+---
+outline: deep
+---
+
+# OneDrive