Skip to content

Commit 83e1caf

Browse files
author
AINative Admin
committed
docs: update README to reflect ZeroDB migration from MongoDB
- Replace MongoDB prerequisites and env vars with ZeroDB configuration - Add "Powered by ZeroDB" section highlighting NoSQL + vector search capabilities - Add ZeroDB and Node.js badges - Update data models reference from Mongoose to ZeroDB compatible - Link to ainative.studio for ZeroDB onboarding
1 parent d3ba0d9 commit 83e1caf

1 file changed

Lines changed: 33 additions & 6 deletions

File tree

README.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,31 @@
33
[![Website](https://img.shields.io/badge/Website-opencapstack.com-blue)](https://opencapstack.com)
44
[![License](https://img.shields.io/badge/License-MIT-green)](LICENSE)
55
[![GitHub Stars](https://img.shields.io/github/stars/Open-Cap-Stack/opencap)](https://github.com/Open-Cap-Stack/opencap/stargazers)
6+
[![Database](https://img.shields.io/badge/Database-ZeroDB-purple)](https://ainative.studio)
7+
[![Node.js](https://img.shields.io/badge/Node.js-18+-339933)](https://nodejs.org)
68

79
**Open-source cap table & equity management platform — a free Carta alternative for startups.**
810

9-
Manage stakeholders, share classes, SAFE notes, equity grants, 409A valuations, documents, data rooms, board management, and financial reporting. Built with Test-Driven Development (TDD) and fully aligned with the [Open Cap Table Alliance (OCTA)](https://www.opencaptablecoalition.com/) schema.
11+
Manage stakeholders, share classes, SAFE notes, equity grants, 409A valuations, documents, data rooms, board management, and financial reporting. Powered by [ZeroDB](https://ainative.studio) — a NoSQL cloud database with built-in vector search, quantum-ready indexing, and real-time sync. Built with Test-Driven Development (TDD) and fully aligned with the [Open Cap Table Alliance (OCTA)](https://www.opencaptablecoalition.com/) schema.
1012

1113
🌐 **[opencapstack.com](https://opencapstack.com)** | 📖 **[Documentation](https://opencapstack.com/docs)** | 💬 **[Community](https://github.com/Open-Cap-Stack/opencap/discussions)**
1214

15+
## Powered by ZeroDB 🗄️
16+
17+
OpenCap Stack uses **[ZeroDB](https://ainative.studio)** as its primary database — a modern NoSQL cloud database that replaces MongoDB, PostgreSQL, and Pinecone with a single unified API.
18+
19+
**Why ZeroDB?**
20+
- **NoSQL + Vector Search** — Document storage and semantic search in one database
21+
- **Zero Infrastructure** — Fully managed cloud database, no servers to maintain
22+
- **Built-in File Storage** — S3-compatible object storage included
23+
- **Quantum-Ready Indexing** — Future-proof vector ranking algorithms
24+
- **Real-Time Events** — Subscribe to data changes via WebSocket
25+
- **One API, One Bill** — Replaces your entire data stack
26+
27+
OpenCap Stack migrated from MongoDB to ZeroDB in early 2026, eliminating 3 separate database dependencies while gaining vector search, file storage, and real-time capabilities out of the box.
28+
29+
👉 **Get started with ZeroDB**: [ainative.studio](https://ainative.studio)
30+
1331
## Development Workflow 📝
1432

1533
This project follows the Semantic Seed Venture Studio Coding Standards (SSCS) which emphasizes:
@@ -28,8 +46,8 @@ Follow these steps to set up the project on your local machine:
2846

2947
### Prerequisites ✅
3048

31-
- Node.js (v14 or higher)
32-
- MongoDB
49+
- Node.js (v18 or higher)
50+
- ZeroDB account ([ainative.studio](https://ainative.studio))
3351
- Docker and Docker Compose (for containerized development)
3452
- Git
3553

@@ -53,11 +71,19 @@ npm install
5371
Create a `.env` file in the root directory and add the following:
5472

5573
```bash
56-
MONGODB_URI=mongodb://mongo:27017/opencap
74+
# ZeroDB (Primary Database)
75+
ENABLE_ZERODB=true
76+
ZERODB_API_KEY=your-zerodb-api-key
77+
ZERODB_BASE_URL=https://api.ainative.studio/api/v1
78+
AINATIVE_API_TOKEN=your-ainative-token
79+
80+
# Server
5781
PORT=5000
82+
JWT_SECRET=your-secret-key
83+
NODE_ENV=development
5884
```
5985

60-
Replace `mongodb://mongo:27017/opencap` with your MongoDB connection string if it's different.
86+
Get your ZeroDB API key at [ainative.studio](https://ainative.studio).
6187

6288
## Running the Project ▶️
6389

@@ -281,11 +307,12 @@ The project structure is organized as follows:
281307
```bash
282308
opencap/
283309
├── controllers/ # Controllers for handling API requests
284-
├── models/ # Mongoose models
310+
├── models/ # Data models (ZeroDB compatible)
285311
├── routes/ # API routes
286312
├── __tests__/ # Test cases (unit, integration)
287313
├── docs/ # Project documentation
288314
├── dags/ # Airflow DAGs for data pipelines
315+
├── services/ # Business logic (ZeroDB client, adapters)
289316
├── .env # Environment variables
290317
├── .github/ # GitHub workflows for CI/CD
291318
├── docker-compose.yml # Docker compose configuration

0 commit comments

Comments
 (0)