Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
71122a2
docs: restructure into modular GitBook-ready format
yash-pouranik Mar 6, 2026
86a2d74
docs: align messaging with official branding and taglines
yash-pouranik Mar 6, 2026
862fc72
style: enhance landing page with official brand color palette and tag…
yash-pouranik Mar 6, 2026
b2710cc
style: replace navbar and brand logos with new official urBACKEND_NAV…
yash-pouranik Mar 6, 2026
49b81d5
style: finalize logo and branding adjustments
yash-pouranik Mar 6, 2026
6ed8daa
Update docs/database.md
yash-pouranik Mar 7, 2026
bd7db4d
Update docs/getting-started.md with proper numbering
yash-pouranik Mar 7, 2026
538c3f1
Update docs/introduction.md with heading of why
yash-pouranik Mar 7, 2026
685d2d5
Update docs/introduction.md
yash-pouranik Mar 7, 2026
a5ba84d
Update docs/security.md with trueness
yash-pouranik Mar 7, 2026
c26a042
fix: issues ponted by coderabbit
yash-pouranik Mar 7, 2026
41bef71
Merge branch 'feat/docs-and-branding' of https://github.com/yash-pour…
yash-pouranik Mar 7, 2026
fe004cf
Update docs/security.md with trueness that auth endpoints are rate li…
yash-pouranik Mar 7, 2026
6164da8
Merge branch 'feat/docs-and-branding' of https://github.com/yash-pour…
yash-pouranik Mar 7, 2026
8dfa099
deleted dev log
yash-pouranik Mar 7, 2026
9e368a2
docs: enrich README and fix GitBook navigation structure
yash-pouranik Mar 7, 2026
2f459fc
docs: clarify that collections must be pre-configured
yash-pouranik Mar 7, 2026
e11d72d
docs: finalize rich README and root summary structure
yash-pouranik Mar 7, 2026
d67955d
docs: remove infrastructure table and add Quick Start link to README
yash-pouranik Mar 7, 2026
0705861
docs: link architecture diagram in README infrastructure section
yash-pouranik Mar 7, 2026
299f3f4
Merge branch 'main' into feat/docs-and-branding
yash-pouranik Mar 7, 2026
95cecb6
feat: implement Auth-Collection Guard Logic (Enable -> Warn flow)
yash-pouranik Mar 7, 2026
4d60336
docs: add schema creation guide and update SUMMARY.md
yash-pouranik Mar 7, 2026
9649564
fix: address code review findings (atomic quota, shared helpers, auth…
yash-pouranik Mar 7, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 0 additions & 145 deletions API_USAGE.md

This file was deleted.

145 changes: 0 additions & 145 deletions DEVLOG.md

This file was deleted.

46 changes: 28 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# urBackend πŸš€

<p align="center">
<img src="banner.png" alt="urBackend Banner" width="100%" />
</p>

<p align="center">
<b>The Instant "Backend-as-a-Service" for Frontend Developers.</b><br/>
Get a managed NoSQL database, JWT Auth, and Cloud Storage in 60 seconds.
<b>Bring your own MongoDB. Get a production-ready backend in 60 seconds.</b><br/>
<i>your backend β€” your database β€” your rules.</i>
</p>

<p align="center">
<a href="https://urbackend.bitbros.in"><strong>Dashboard</strong></a> Β·
<a href="API_USAGE.md"><strong>Docs</strong></a> Β·
<a href="docs/introduction.md"><strong>Docs</strong></a> Β·
<a href="docs/getting-started.md"><strong>Quick Start</strong></a> Β·
<a href="https://discord.gg/CXJjvJkNWn"><strong>Discord</strong></a>
</p>

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

## 🟒 Powerful Features

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

---

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

---

## πŸ› οΈ Infrastructure
## πŸ—οΈ How it Works (The Visual Flow)

<div align="center">
```mermaid
graph LR
A[1. Connect MongoDB] --> B[2. Define Collections]
B --> C[3. πŸš€ Instant REST APIs]
C --> D[4. Scale & Monitor]
```

| **Core System** | **Developer UI** | **Data Layer** |
| :--- | :--- | :--- |
| Node.js & Express | React.js (Vite) | MongoDB (Mongoose) |
| JWT Authentication | Lucide React | Redis & BullMQ |
| Storage Manager | Recharts | Supabase (BYOD) |
---

</div>
## πŸ—οΈ 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.
Expand Down
19 changes: 19 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Summary

* [Summary](README.md)
* [API Quick Reference πŸ“‘](docs/api-reference.md)
* [Introduction πŸš€](docs/introduction.md)
* [Getting Started πŸ› οΈ](docs/getting-started.md)
* [Authentication πŸ”](docs/authentication.md)
* [Database Operations πŸ—„οΈ](docs/database.md)
* [Schema Creation 🧱](docs/schemas.md)
* [Cloud Storage ☁️](docs/storage.md)
* [Security & Keys πŸ›‘οΈ](docs/security.md)

---
## Project & Community 🀝
* [Architecture Diagram](ARCHITECTURE_DIAGRAM.md)
* [Contributing](CONTRIBUTING.md)
* [Code of Conduct](CODE_OF_CONDUCT.md)
* [Security Policy](SECURITY.md)
* [License](LICENSE.md)
Loading