fix: docs: add DEPLOYMENT.md and link in README (fixes #42)

Author: Pangea 3

DEPLOYMENT.md

@@ -0,0 +1,37 @@
+# 🚀 Deployment Guide
+
+This guide explains how to self-host and deploy **urBackend** using popular free-tier platforms like Render/Railway (Backend) and Vercel (Frontend).
+
+## 1. Deploying the Backend (Node.js)
+
+You can deploy the backend to platforms like [Render](https://render.com) or [Railway.app](https://railway.app).
+
+### Prerequisites
+- A [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) cluster (Free tier available).
+- A [Redis](https://upstash.com/) instance (Upstash is recommended for a managed free-tier).
+
+### Deployment Steps
+1. Connect your GitHub repository to Render/Railway.
+2. Set the **Build Command** to `npm install` and the **Start Command** to `npm start` (ensure it points to the `backend` directory).
+3. Add the following **Environment Variables**:
+   ```env
+   MONGODB_URI=your_mongodb_connection_string
+   REDIS_URL=your_redis_connection_string
+   JWT_SECRET=your_super_secret_string
+   # Add other variables from .env.example
+   ```
+
+## 2. Deploying the Frontend (Vite/React)
+
+The frontend is a static site that can be easily hosted on [Vercel](https://vercel.com) or Render.
+
+### Deployment Steps
+1. Import the repository into Vercel.
+2. Set the **Root Directory** to `frontend`.
+3. Vercel should automatically detect the framework as Vite. The Build Command is `npm run build` and the Output Directory is `dist`.
+4. **Important**: Configure the API connection by adding the following Environment Variable in your dashboard:
+   - `VITE_API_BASE_URL`: The URL of your deployed backend (e.g., `https://your-backend.onrender.com`)
+
+## 💡 Tips
+- Ensure your MongoDB Atlas IP access list allows connections from everywhere (`0.0.0.0/0`) if using shared hosting.
+- Check your platform logs if the build fails; verify that all dependencies are installed via `npm install`.

README.md

@@ -13,6 +13,7 @@
   <a href="https://urbackend.bitbros.in"><strong>Dashboard</strong></a> ·
   <a href="docs/introduction.md"><strong>Docs</strong></a> ·
   <a href="docs/getting-started.md"><strong>Quick Start</strong></a> ·
+  <a href="DEPLOYMENT.md"><strong>Self-Hosting</strong></a> ·
   <a href="https://discord.gg/CXJjvJkNWn"><strong>Discord</strong></a>
 </p>
 
@@ -48,47 +49,4 @@ Go from zero to a live backend in **under 60 seconds**.
 
 1.  **Initialize**: Create a project on the [Dashboard](https://urbackend.bitbros.in).
 2.  **Model**: Visually define your collections and schemas.
-3.  **Execute**: Push and pull data immediately using your Instant API Key.
-
-```javascript
-// Power your UI with zero backend boilerplate
-const res = await fetch('https://api.urbackend.bitbros.in/api/data/products', {
-  headers: { 'x-api-key': 'your_pk_live_key' }
-});
-```
-
----
-
-## 🏗️ How it Works (The Visual Flow)
-
-```mermaid
-graph LR
-    A[1. Connect MongoDB] --> B[2. Define Collections]
-    B --> C[3. 🚀 Instant REST APIs]
-    C --> D[4. Scale & Monitor]
-```
-
----
-
-## 🏗️ Architecture
-
-Explore our [Architecture Diagram](ARCHITECTURE_DIAGRAM.md) to understand the system design, core components, and data flow in detail.
-
----
-## 🤝 Community
-
-Join hundreds of developers building faster without the backend headaches.
-
-- [GitHub Issues](https://github.com/yash-pouranik/urbackend/issues): Report bugs & request features.
-- [Discord Channel](https://discord.gg/CXJjvJkNWn): Join the conversation.
-- [Contributing](CONTRIBUTING.md): Help us grow the ecosystem.
-
----
-
-## Contributors
-
-<a href="https://github.com/yash-pouranik/urbackend/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=yash-pouranik/urbackend" />
-</a>
-
-Built with ❤️ by the **urBackend** community.
+3.  **Execute**: Push and pull data immediately using your