📑 : Added Wiki Docs

docs/api.md

@@ -0,0 +1,17 @@
+# API
+
+> This package is located in the `packages/api` directory of the monorepo.
+
+## 📝 Description
+
+The API package includes the API server for the ShareX server. It allows users to perform various actions, such as uploading files, images, or text, and generating short URLs.
+
+## 🚀 Technologies
+
+- [Node.js](https://nodejs.org/en/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Express.js](https://expressjs.com/)
+- [Cloudflare R2](https://developers.cloudflare.com/r2/)
+- [PostgreSQL](https://www.postgresql.org/)
+- [Hasura](https://hasura.io/)
+- [Redis](https://redis.io/)

docs/cli.md

@@ -0,0 +1,13 @@
+# CLI
+
+> This package is located in the `packages/cli` directory of the monorepo.
+
+## 📝 Description
+
+The CLI package includes the command-line interface (CLI) for interacting with the ShareX server from the terminal. It allows users to perform various actions, such as uploading files, images, or text, and generating short URLs.
+
+## 🚀 Technologies
+
+- [Node.js](https://nodejs.org/en/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Commander.js](https://npmjs.com/package/commander)

docs/dashboard.md

@@ -0,0 +1,15 @@
+## Dashboard
+
+> This package is located in the `packages/dashboard` directory of the monorepo.
+
+### 📝 Description
+
+The dashboard package includes the web dashboard for the ShareX server. It allows users to perform various actions, such as uploading files, images, or text, and generating short URLs.
+
+### 🚀 Technologies
+
+- [Node.js](https://nodejs.org/en/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [React.js](https://reactjs.org/)
+- [Next.js](https://nextjs.org/)
+- [Tailwind CSS](https://tailwindcss.com/)

docs/discord.md

@@ -0,0 +1,14 @@
+## Discord
+
+> This package is located in the `packages/dashboard` directory of the monorepo.
+
+### 📝 Description
+
+The Discord package contains the Discord bot for the ShareX server. It allows users to upload files, images, and text, as well as generate short URLs, directly from Discord.
+
+### 🚀 Technologies
+
+- [Node.js](https://nodejs.org/en/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Discord.js](https://discord.js.org/)
+

docs/footer.md

@@ -0,0 +1 @@
+SHX @ BRAVO68WEB

docs/hello.md

@@ -1 +0,0 @@
-## SHX Wiki Docs

docs/homepage.md

@@ -0,0 +1,10 @@
+## SHX Wiki Docs
+
+Welcome to the SHX Wiki Docs! This is the place to find all the information you need to know about SHX.
+
+### Index
+
+- [Intro](intro.md)
+- [Getting Started](getting-started.md)
+- [Packages](packages.md)
+- [Installation](installation.md)

docs/installation-api.md

@@ -0,0 +1,37 @@
+# Installation (API)
+
+## 📦 Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+
+## 📥 Installation
+
+1. Navigate to the `packages/api` directory:
+
+```bash
+cd packages/api
+```
+
+2. Copy the `.env.example` file to `.env` and fill in the required values:
+
+```bash
+cp .env.example .env
+```
+
+3. Snip up the server:
+
+```bash
+docker compose up -d
+
+```
+
+4. The server should now be running on port `4000` by default. You can verify this by running:
+
+```bash
+docker compose ps
+```
+
+## 📝 Configuration
+
+**Note**: For R2 keys you must have an cloudflare account and a domain name.

docs/installation-cli.md

@@ -0,0 +1,48 @@
+# Installation (CLI)
+
+## 📦 Prerequisites
+
+- [Node.js](https://nodejs.org/en/download/)
+- [Yarn](https://classic.yarnpkg.com/en/docs/install/)
+
+## 📥 Installation
+
+### From Source
+
+1. Navigate to the `packages/cli` directory:
+
+```bash
+cd packages/cli
+```
+
+2. Install all dependencies:
+
+```bash
+yarn install
+```
+
+3. Install CLI:
+
+```bash
+yarn r
+```
+
+4. The CLI should now be installed. You can verify this by running:
+
+```bash
+shx --help
+```
+
+### From NPM
+
+1. Install CLI:
+
+```bash
+yarn global add shx-cli
+```
+
+2. The CLI should now be installed. You can verify this by running:
+
+```bash
+shx --help
+```

docs/installation-dashboard.md

@@ -0,0 +1,22 @@
+# Installation (Dashboard)
+
+## 📦 Prerequisites
+
+- [Node.js](https://nodejs.org/en/download/)
+- [Yarn](https://classic.yarnpkg.com/en/docs/install/)
+
+## 📥 Installation
+
+### Using Vercel
+
+1. Fork this repository.
+
+2. Create a new project on [Vercel](https://vercel.com/).
+
+3. Connect your GitHub account to Vercel.
+
+4. Import your forked repository.
+
+![Vercel Import](https://safe.b68dev.xyz/Pp6WHAxb.png)
+
+5. Setup your custom domain (optional).

docs/installation-discord.md

@@ -0,0 +1,38 @@
+# Installation (Discord Bot)
+
+## 📦 Prerequisites
+
+- [Node.js](https://nodejs.org/en/download/)
+- [Yarn](https://classic.yarnpkg.com/en/docs/install/)
+
+## 📥 Installation
+
+1. Navigate to the `packages/discord` directory:
+
+```bash
+cd packages/discord
+```
+
+2. Install all dependencies:
+
+```bash
+yarn install
+```
+
+3. Copy the `.env.example` file to `.env` and fill in the required values:
+
+```bash
+cp .env.example .env
+```
+
+4. Build the bot:
+
+```bash
+yarn build
+```
+
+5. Start the bot:
+
+```bash
+yarn start
+```

docs/installation.md

@@ -0,0 +1,6 @@
+## Intallation
+
+- [api](installation-api.md)
+- [dashboard](installation-dashboard.md)
+- [cli](installation-cli.md)
+- [discord](installation-discord.md)

docs/intro.md

@@ -0,0 +1,15 @@
+## SHX
+
+## 📝 Description
+
+Shx is a platform ment to store and share files, images, text and URLs with ease. This server is built using Node.js and Express.js and stores the uploaded content on Cloudflare R2 and PostgreSQL DB. It is compatible with ShareX and other clients that support the same protocol.
+
+## 🚀 Features
+
+- File upload
+- Image upload
+- Text upload
+- URL shortener
+- CLI Support
+- Web Dashboard
+- Discord Bot Support

docs/packages.md

@@ -0,0 +1,8 @@
+## 🎁 Project Setup
+
+This project is a monorepo managed using [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces/). It contains the following packages:
+
+- [cli](cli.md)
+- [discord](discord.md)
+- [dashboard](dashboard.md)
+- [api](api.md)