Updated Readme.md
This commit is contained in:
parent
dc810e717c
commit
15d3ce5292
175
README.md
175
README.md
@ -1,113 +1,140 @@
|
||||
# Inspiration Engine
|
||||
> *Inspiration Engine — your private creative memory. Search by idea, not filename.*
|
||||
<div align="center">
|
||||
|
||||
**A private, open-source creative memory system for organizing, searching, and reusing your inspiration.**
|
||||
# ✨ Inspiration Engine
|
||||
|
||||
---
|
||||
**Your private creative memory. Search by idea, not filename.**
|
||||
|
||||
[]()
|
||||
[]()
|
||||
|
||||
**[Chat with this repository](https://n8n.biohazardvfx.com/webhook/027eb8bf-1217-4bbb-8189-6ec99023a53a/chat)**
|
||||
|
||||
---
|
||||
|
||||
## Vision
|
||||
</div>
|
||||
|
||||
To create the **interoperability layer for creative memory** — an open ecosystem where creators, developers, and AI tools can manage creative assets seamlessly and privately.
|
||||
## What is This?
|
||||
|
||||
---
|
||||
A unified, encrypted library for images, videos, links, and notes that you can actually *find* again. No more scattered Pinterest boards, lost TikToks, or forgotten bookmarks. Just one searchable creative memory that understands what's *in* your content, not just its filename.
|
||||
|
||||
## Why It’s Different
|
||||
```
|
||||
"burnt orange hoodie in strong rim light" → finds it instantly
|
||||
No tags. No folders. Just search by what you remember.
|
||||
```
|
||||
|
||||
Most bookmarking apps trade convenience for privacy.
|
||||
**Inspiration Engine** is built for creative professionals who manage massive visual libraries and need **security, flexibility, and intelligence**.
|
||||
## Core Principles
|
||||
|
||||
### Key Advantages
|
||||
- **End-to-End Encryption** — all processing happens on your device.
|
||||
- **Bring-Your-Own Storage** — local disk, S3, Nextcloud, or any provider.
|
||||
- **Multimodal Search** — semantic and visual search across text, images, video, and audio.
|
||||
- **Open Standards** — powered by **OCMS** (Open Creative Memory Spec) and **CRQL** (Creative Retrieval Query Language).
|
||||
- **Native Ingest** — direct connectors for major social and creative platforms.
|
||||
<table>
|
||||
<tr>
|
||||
<td width="25%" align="center"><b> Private by Design</b><br/>E2EE encryption. Zero server visibility.</td>
|
||||
<td width="25%" align="center"><b> Multimodal Search</b><br/>OCR + vision embeddings across all media.</td>
|
||||
<td width="25%" align="center"><b> Native Ingest</b><br/>Automated capture from social platforms.</td>
|
||||
<td width="25%" align="center"><b> Own Your Data</b><br/>BYO storage. Open standards. Full exports.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
---
|
||||
## The Differentiators
|
||||
|
||||
## Core Features
|
||||
Unlike **Raindrop.io** (no E2EE, limited storage), **Pinterest** (public-first), **mymind** (closed ecosystem), or **Eagle** (local-only):
|
||||
|
||||
- **Semantic Search** — find ideas, not filenames.
|
||||
- **Private Creative OS** — full data ownership and portability.
|
||||
- **AI Intelligence** — automatic tagging, clustering, and relationship mapping.
|
||||
- **Multimodal Asset Support** — images, video, audio, and documents.
|
||||
- **Developer API** — OpenAPI spec with SDKs in TypeScript, Python, Swift, and Kotlin.
|
||||
- **Freemium Model** — open core, with optional team and API tiers.
|
||||
- **Search semantically** → "sunset over water" finds it even if you named it `IMG_2847.jpg`
|
||||
- **Encrypted end-to-end** → Only you can decrypt your content
|
||||
- **Auto-ingest from Instagram, TikTok, X** → Stop manually saving everything
|
||||
- **Bring your own S3/Nextcloud** → No arbitrary storage caps
|
||||
- **Open standards (OCMS/CRQL)** → Export anytime, integrate anywhere
|
||||
|
||||
---
|
||||
## Architecture
|
||||
|
||||
## Architecture & Open Source Stack
|
||||
```
|
||||
┌─────────────┐
|
||||
│ Client │ ← E2EE, Local OCR, Vision Embeddings
|
||||
└──────┬──────┘
|
||||
│ encrypted
|
||||
┌──────▼──────┐
|
||||
│ Cloudflare │ ← Metadata only, Workers, D1, R2
|
||||
│ Platform │
|
||||
└──────┬──────┘
|
||||
│
|
||||
┌──────▼──────┐
|
||||
│ Qdrant │ ← Vector search (encrypted)
|
||||
└─────────────┘
|
||||
```
|
||||
|
||||
| Layer | Description |
|
||||
|:------|:-------------|
|
||||
| **OCMS** | Defines asset + metadata schema for creative memory. |
|
||||
| **CRQL** | Query language for semantic and visual search. |
|
||||
| **Local Indexer** | On-device runtime with OCR and vision embeddings. |
|
||||
| **Storage Adapters** | Support for S3, WebDAV, SMB, Nextcloud, or local disk. |
|
||||
| **Reference Server** | Stateless API backed by PostgreSQL + vector store. |
|
||||
| **E2EE Media Envelope** | Client-side encryption for assets and embeddings. |
|
||||
**Stack**: Next.js • Cloudflare Workers • D1 • R2 • Qdrant • ONNX
|
||||
|
||||
---
|
||||
## Documentation
|
||||
|
||||
## Target Audience
|
||||
<details>
|
||||
<summary><b> Project Brief</b> - Product vision & MVP scope</summary>
|
||||
|
||||
- Designers, filmmakers, artists, photographers
|
||||
- Developers building creative or AI tools
|
||||
- Content teams managing large inspiration libraries
|
||||
- Anyone who wants a **private, searchable creative archive**
|
||||
→ See `Project-Brief.md` for target users, success metrics, and technical requirements.
|
||||
</details>
|
||||
|
||||
---
|
||||
<details>
|
||||
<summary><b> Competitive Analysis</b> - Market positioning</summary>
|
||||
|
||||
## Competitive Advantage
|
||||
→ See `Competitive-Analysis-Report.md` for how we stack up against Raindrop, Pinterest, et al.
|
||||
</details>
|
||||
|
||||
| Competitor | Limitation | Inspiration Engine |
|
||||
|:------------|:------------|:--------------------|
|
||||
| **Raindrop.io** | Cloud-only, text-based search | E2EE + multimodal |
|
||||
| **Milanote** | Closed ecosystem | Open standards (OCMS / CRQL) |
|
||||
| **Pinterest** | Public by default | 100% private |
|
||||
| **Cloud drives** | File-based, not idea-based | Semantic + visual search |
|
||||
<details>
|
||||
<summary><b> Open Source Strategy</b> - OCMS & CRQL specs</summary>
|
||||
|
||||
---
|
||||
→ See `Ideation-Session-02.md` for our plan to become the interoperability layer for creative memory.
|
||||
</details>
|
||||
|
||||
## Getting Started
|
||||
<details>
|
||||
<summary><b> Brainstorming Results</b> - How we got here</summary>
|
||||
|
||||
### For Users
|
||||
1. Install the desktop, web, or mobile app.
|
||||
2. Connect your social or cloud accounts.
|
||||
3. Save your inspiration.
|
||||
4. Search using natural language or visual concepts.
|
||||
→ See `Brainstorm-Session-Results.md` for the ideation process.
|
||||
</details>
|
||||
|
||||
### For Developers
|
||||
1. Review the [OpenAPI specification](docs/openapi.md).
|
||||
2. Explore SDKs in [TypeScript](packages/ts-sdk), [Python](packages/python-sdk), [Swift](packages/swift-sdk), and [Kotlin](packages/kotlin-sdk).
|
||||
3. Contribute to the [Reference Server](packages/reference-server).
|
||||
4. Build new platform connectors with the [Connector SDK](packages/connector-sdk).
|
||||
## MVP Goals
|
||||
|
||||
---
|
||||
| Metric | Target | Why |
|
||||
|--------|--------|-----|
|
||||
| Week 1 Retention | ≥60% | Prove core value |
|
||||
| Search Response | ≤300ms | Instant feel |
|
||||
| Items Saved/Week | ≥10 | Measure capture depth |
|
||||
| Search Usage | ≥75% weekly | Validate semantic search |
|
||||
|
||||
## Community & Contribution
|
||||
## Quick Start
|
||||
|
||||
We welcome contributions to the open-source ecosystem:
|
||||
- Submit feature requests and bug reports
|
||||
- Contribute to specifications (OCMS, CRQL)
|
||||
- Build integrations for new platforms
|
||||
- Improve documentation and examples
|
||||
|
||||
---
|
||||
```bash
|
||||
# Clone
|
||||
git clone https://git.biohazardvfx.com/Nicholai/inspiration-app.git
|
||||
|
||||
# Install
|
||||
pnpm install
|
||||
|
||||
# Run locally
|
||||
pnpm dev
|
||||
|
||||
# Deploy to Cloudflare
|
||||
pnpm deploy
|
||||
```
|
||||
|
||||
## Roadmap
|
||||
|
||||
- [x] Core architecture & specs
|
||||
- [x] Competitive analysis
|
||||
- [ ] MVP: Instagram connector + semantic search
|
||||
- [ ] Mobile apps (iOS/Android)
|
||||
- [ ] Additional social connectors
|
||||
- [ ] BYO storage adapters
|
||||
- [ ] Developer API
|
||||
- [ ] Teams & collaboration
|
||||
|
||||
## License
|
||||
|
||||
| Component | License |
|
||||
|:-----------|:----------|
|
||||
| Code | Apache 2.0 |
|
||||
| Specifications | Creative Commons BY |
|
||||
| Examples / Fixtures | CC BY or CC0 |
|
||||
Code: **Apache 2.0** • Specs: **CC BY**
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
> *Inspiration Engine — your private creative memory. Search by idea, not filename.*
|
||||
**Built for creators who are tired of losing their inspiration**
|
||||
|
||||
*Questions? [Chat with this repo](https://n8n.biohazardvfx.com/webhook/027eb8bf-1217-4bbb-8189-6ec99023a53a/chat)*
|
||||
|
||||
</div>
|
||||
Loading…
x
Reference in New Issue
Block a user