Skip to content

Commit 830ce83

Browse files
author
Pangea 3
committed
fix: docs: add DEPLOYMENT.md guide (fixes #42)
1 parent 058c311 commit 830ce83

2 files changed

Lines changed: 41 additions & 45 deletions

File tree

DEPLOYMENT.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Deployment Guide
2+
3+
This guide will help you self-host your own instance of **urBackend**.
4+
5+
## 1. Deploying the Backend
6+
7+
You can deploy the backend to platforms like [Render](https://render.com) or [Railway.app](https://railway.app).
8+
9+
### Prerequisites
10+
- **MongoDB Atlas**: Create a free cluster for your database.
11+
- **Redis**: Use [Upstash](https://upstash.com) for a managed Redis instance.
12+
13+
### Environment Variables
14+
Ensure you set the following in your platform's dashboard:
15+
16+
```env
17+
PORT=3000
18+
MONGO_URI=your_mongodb_connection_string
19+
REDIS_URL=your_redis_url
20+
JWT_SECRET=your_secret_key
21+
# Add other keys required by your .env.example
22+
```
23+
24+
### Steps
25+
1. Connect your GitHub repository to Render/Railway.
26+
2. Set the root directory to `backend/`.
27+
3. Add the environment variables listed above.
28+
4. Deploy!
29+
30+
## 2. Deploying the Frontend
31+
32+
You can deploy the Vite/React dashboard to [Vercel](https://vercel.com) or Render.
33+
34+
### Steps
35+
1. Import the repository in Vercel.
36+
2. Set the root directory to `frontend/`.
37+
3. Add the following environment variable:
38+
- `VITE_API_BASE_URL`: The URL of your deployed backend (e.g., `https://your-backend.onrender.com`).
39+
4. Deploy!

README.md

Lines changed: 2 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<p align="center">
1313
<a href="https://urbackend.bitbros.in"><strong>Dashboard</strong></a> ·
1414
<a href="docs/introduction.md"><strong>Docs</strong></a> ·
15-
<a href="docs/getting-started.md"><strong>Quick Start</strong></a> ·
15+
<a href="DEPLOYMENT.md"><strong>Self-Hosting</strong></a> ·
1616
<a href="https://discord.gg/CXJjvJkNWn"><strong>Discord</strong></a>
1717
</p>
1818

@@ -48,47 +48,4 @@ Go from zero to a live backend in **under 60 seconds**.
4848

4949
1. **Initialize**: Create a project on the [Dashboard](https://urbackend.bitbros.in).
5050
2. **Model**: Visually define your collections and schemas.
51-
3. **Execute**: Push and pull data immediately using your Instant API Key.
52-
53-
```javascript
54-
// Power your UI with zero backend boilerplate
55-
const res = await fetch('https://api.urbackend.bitbros.in/api/data/products', {
56-
headers: { 'x-api-key': 'your_pk_live_key' }
57-
});
58-
```
59-
60-
---
61-
62-
## 🏗️ How it Works (The Visual Flow)
63-
64-
```mermaid
65-
graph LR
66-
A[1. Connect MongoDB] --> B[2. Define Collections]
67-
B --> C[3. 🚀 Instant REST APIs]
68-
C --> D[4. Scale & Monitor]
69-
```
70-
71-
---
72-
73-
## 🏗️ Architecture
74-
75-
Explore our [Architecture Diagram](ARCHITECTURE_DIAGRAM.md) to understand the system design, core components, and data flow in detail.
76-
77-
---
78-
## 🤝 Community
79-
80-
Join hundreds of developers building faster without the backend headaches.
81-
82-
- [GitHub Issues](https://github.com/yash-pouranik/urbackend/issues): Report bugs & request features.
83-
- [Discord Channel](https://discord.gg/CXJjvJkNWn): Join the conversation.
84-
- [Contributing](CONTRIBUTING.md): Help us grow the ecosystem.
85-
86-
---
87-
88-
## Contributors
89-
90-
<a href="https://github.com/yash-pouranik/urbackend/graphs/contributors">
91-
<img src="https://contrib.rocks/image?repo=yash-pouranik/urbackend" />
92-
</a>
93-
94-
Built with ❤️ by the **urBackend** community.
51+
3. **Execute**: Push and pull data immediately using your

0 commit comments

Comments
 (0)