Skip to content

Commit 4a7a0e5

Browse files
Merge pull request #37 from yash-pouranik/feat/docs-and-branding
Feat/docs and branding
2 parents 03a8b93 + 9649564 commit 4a7a0e5

24 files changed

Lines changed: 549 additions & 400 deletions

API_USAGE.md

Lines changed: 0 additions & 145 deletions
This file was deleted.

DEVLOG.md

Lines changed: 0 additions & 145 deletions
This file was deleted.

README.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1+
# urBackend 🚀
2+
13
<p align="center">
24
<img src="banner.png" alt="urBackend Banner" width="100%" />
35
</p>
6+
47
<p align="center">
5-
<b>The Instant "Backend-as-a-Service" for Frontend Developers.</b><br/>
6-
Get a managed NoSQL database, JWT Auth, and Cloud Storage in 60 seconds.
8+
<b>Bring your own MongoDB. Get a production-ready backend in 60 seconds.</b><br/>
9+
<i>your backend — your database — your rules.</i>
710
</p>
811

912
<p align="center">
1013
<a href="https://urbackend.bitbros.in"><strong>Dashboard</strong></a> ·
11-
<a href="API_USAGE.md"><strong>Docs</strong></a> ·
14+
<a href="docs/introduction.md"><strong>Docs</strong></a> ·
15+
<a href="docs/getting-started.md"><strong>Quick Start</strong></a> ·
1216
<a href="https://discord.gg/CXJjvJkNWn"><strong>Discord</strong></a>
1317
</p>
1418

@@ -27,12 +31,14 @@ urBackend is an **Open-Source BaaS** built to eliminate the complexity of backen
2731

2832
## 🟢 Powerful Features
2933

30-
- `>_` **Instant NoSQL Database**: Create collections and push JSON data instantly.
31-
- `>_` **Managed Authentication**: Sign Up, Login, and Profile management with JWT.
32-
- `>_` **Cloud Storage**: Managed file/image uploads with public CDN links.
33-
- `>_` **Bring Your Own Database**: Connect your own MongoDB or Supabase instance.
34-
- `>_` **Real-time Analytics**: Monitor traffic and resource usage from a premium dashboard.
35-
- `>_` **Secure Architecture**: Dual-key separation (`pk_live` & `sk_live`) for total safety.
34+
| Feature | Description |
35+
| :--- | :--- |
36+
| **Instant NoSQL** | Create collections and push JSON data instantly with zero boilerplate. |
37+
| **Managed Auth** | Sign Up, Login, and Profile management with JWT built-in. |
38+
| **Cloud Storage** | Managed file/image uploads with public CDN links. |
39+
| **BYO Database** | Connect your own MongoDB Atlas or self-hosted instance. |
40+
| **Real-time Analytics** | Monitor traffic and resource usage from a premium dashboard. |
41+
| **Secure Architecture** | Dual-key separation (`pk_live` & `sk_live`) for total safety. |
3642

3743
---
3844

@@ -53,22 +59,26 @@ const res = await fetch('https://api.urbackend.bitbros.in/api/data/products', {
5359

5460
---
5561

56-
## 🛠️ Infrastructure
62+
## 🏗️ How it Works (The Visual Flow)
5763

58-
<div align="center">
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+
```
5970

60-
| **Core System** | **Developer UI** | **Data Layer** |
61-
| :--- | :--- | :--- |
62-
| Node.js & Express | React.js (Vite) | MongoDB (Mongoose) |
63-
| JWT Authentication | Lucide React | Redis & BullMQ |
64-
| Storage Manager | Recharts | Supabase (BYOD) |
71+
---
6572

66-
</div>
73+
## 🏗️ Architecture
6774

68-
---
75+
Explore our [Architecture Diagram](ARCHITECTURE_DIAGRAM.md) to understand the system design, core components, and data flow in detail.
6976

77+
---
7078
## 🤝 Community
7179

80+
Join hundreds of developers building faster without the backend headaches.
81+
7282
- [GitHub Issues](https://github.com/yash-pouranik/urbackend/issues): Report bugs & request features.
7383
- [Discord Channel](https://discord.gg/CXJjvJkNWn): Join the conversation.
7484
- [Contributing](CONTRIBUTING.md): Help us grow the ecosystem.

SUMMARY.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Summary
2+
3+
* [Summary](README.md)
4+
* [API Quick Reference 📑](docs/api-reference.md)
5+
* [Introduction 🚀](docs/introduction.md)
6+
* [Getting Started 🛠️](docs/getting-started.md)
7+
* [Authentication 🔐](docs/authentication.md)
8+
* [Database Operations 🗄️](docs/database.md)
9+
* [Schema Creation 🧱](docs/schemas.md)
10+
* [Cloud Storage ☁️](docs/storage.md)
11+
* [Security & Keys 🛡️](docs/security.md)
12+
13+
---
14+
## Project & Community 🤝
15+
* [Architecture Diagram](ARCHITECTURE_DIAGRAM.md)
16+
* [Contributing](CONTRIBUTING.md)
17+
* [Code of Conduct](CODE_OF_CONDUCT.md)
18+
* [Security Policy](SECURITY.md)
19+
* [License](LICENSE.md)

0 commit comments

Comments
 (0)