feat: update README with LemonSpace branding, features, and self-hosting instructions
- Revamped README to reflect LemonSpace's vision and features - Added sections on tech stack, installation, environment variables, and pricing - Included self-hosting instructions and project structure - Enhanced documentation for contribution guidelines and support
This commit is contained in:
113
LICENSE.md
Normal file
113
LICENSE.md
Normal file
@@ -0,0 +1,113 @@
|
||||
# Business Source License 1.1
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Value |
|
||||
|-----------|-------|
|
||||
| Licensor | LemonSpace |
|
||||
| Licensed Work | LemonSpace Web Application |
|
||||
| Additional Use Grant | Use is limited to private and personal, non-commercial purposes only. |
|
||||
| Change Date | 3 years after the initial publication of each specific version |
|
||||
| Change License | Apache License 2.0 |
|
||||
|
||||
## License Text
|
||||
|
||||
### Business Source License 1.1
|
||||
|
||||
**Licensed Work:** LemonSpace Web Application
|
||||
|
||||
**Licensor:** LemonSpace
|
||||
|
||||
**Change Date:** The earlier of (a) three (3) years from the date the Licensed Work is made available, or (b) the date on which the Licensed Work is designated by Licensor as having met the Change Date criteria.
|
||||
|
||||
**Change License:** Apache License 2.0
|
||||
|
||||
**Additional Use Grant:** You may use the Licensed Work solely for private and personal, non-commercial purposes. "Commercial use" means any use of the Licensed Work by or for the benefit of a business, organization, or individual in connection with any commercial activity, including but not limited to:
|
||||
|
||||
- Internal business operations
|
||||
- Providing products or services to third parties
|
||||
- Any use that generates revenue
|
||||
- Use within an organization of any size for business purposes
|
||||
|
||||
If you wish to use the Licensed Work for any commercial purpose, you must obtain a separate commercial license from the Licensor. Contact: [licensing@lemonspace.io]
|
||||
|
||||
---
|
||||
|
||||
### Terms
|
||||
|
||||
The Licensed Work is provided under the terms of this Business Source License 1.1 ("License"). Use, reproduction, modification, or distribution of the Licensed Work requires compliance with this License.
|
||||
|
||||
**1. License Grant.** Subject to the terms of this License, Licensor grants you a non-exclusive, worldwide, non-transferable license to use, reproduce, modify, and distribute the Licensed Work solely for the Additional Use Grant purposes, subject to the following conditions:
|
||||
|
||||
**2. Source Code.** The Licensed Work is provided in source code form. You may use the source code to understand, modify, and build the Licensed Work for the permitted purposes.
|
||||
|
||||
**3. No Commercial Use.** You may not use the Licensed Work for any commercial purpose without obtaining a separate commercial license. Commercial use includes, but is not limited to, any use within a for-profit organization, any use that generates revenue, and any use in connection with business operations.
|
||||
|
||||
**4. Derivative Works.** You may create derivative works based on the Licensed Work, provided that:
|
||||
|
||||
a) All derivative works are subject to this License;
|
||||
|
||||
b) You clearly indicate that your work is a derivative work;
|
||||
|
||||
c) You include the original copyright notice and this License.
|
||||
|
||||
**5. Redistribution.** You may redistribute the Licensed Work, provided that:
|
||||
|
||||
a) You include a copy of this License;
|
||||
|
||||
b) You retain all copyright notices;
|
||||
|
||||
c) You include the Licensor's name and contact information.
|
||||
|
||||
**6. Change License.** After the Change Date, the Licensed Work will become available under the Change License (Apache License 2.0). From that point forward, you may use the Licensed Work under the terms of the Change License.
|
||||
|
||||
**7. Disclaimer.** THE LICENSED WORK IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE LICENSOR BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY ARISING FROM THE USE OF THE LICENSED WORK.
|
||||
|
||||
**8. Compliance.** Your use of the Licensed Work constitutes acceptance of this License. If you do not agree to the terms of this License, you may not use the Licensed Work.
|
||||
|
||||
---
|
||||
|
||||
### Change License (Apache License 2.0)
|
||||
|
||||
After the Change Date, the Licensed Work will be available under the Apache License 2.0:
|
||||
|
||||
```
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
2. Copyright.
|
||||
3. Grant of Copyright License.
|
||||
4. Redistribution.
|
||||
5. Submission of Contributions.
|
||||
6. Trademarks.
|
||||
7. Disclaimer of Warranty.
|
||||
8. Limitation of Liability.
|
||||
9. Accepting Warranty or Additional Liability.
|
||||
```
|
||||
|
||||
The full Apache License 2.0 text is available at: http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
---
|
||||
|
||||
### Commercial Licensing
|
||||
|
||||
For commercial use, self-hosted deployments in business environments, or enterprise licensing, please contact:
|
||||
|
||||
**Email:** licensing@lemonspace.io
|
||||
**Website:** https://lemonspace.io
|
||||
|
||||
#### Planned Commercial Licenses
|
||||
|
||||
| License | Target | Details |
|
||||
|---------|--------|---------|
|
||||
| Small Business | Organizations ≤ 10 employees | Price TBD |
|
||||
| Enterprise | Organizations > 10 employees | Price TBD |
|
||||
| OEM / Reseller | Embedding in third-party products | Individual agreement |
|
||||
|
||||
---
|
||||
|
||||
*License Version 1.0 — March 2026*
|
||||
198
README.md
198
README.md
@@ -1,36 +1,196 @@
|
||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
||||
# 🍋 LemonSpace
|
||||
|
||||
**Self-Hosted, Source-Available Creative Workspace**
|
||||
|
||||
LemonSpace ist eine visuelle Arbeitsfläche, auf der kreative Teams aus wenigen Input-Assets schnell kampagnenfähige Bildvarianten erzeugen — mit KI-gestützter Generierung, durchdachter Latenz-UX und voller Kontrolle über ihre Daten.
|
||||
|
||||
## Vision
|
||||
|
||||
Vom Rohbild zur fertigen Kampagnenvariante in Minuten statt Stunden — auf eigener Infrastruktur oder als gehosteter Service.
|
||||
|
||||
## Features
|
||||
|
||||
### Infinite Canvas
|
||||
- Zoom, Pan und Navigation auf einem unbegrenzten Canvas
|
||||
- Node-basiertes Workflow-System
|
||||
- Drag & Drop von Assets und KI-Outputs
|
||||
- Gruppierung und Layering von Elementen
|
||||
|
||||
### Node-System
|
||||
|
||||
| Kategorie | Nodes |
|
||||
|-----------|-------|
|
||||
| **Quelle** | Bild, Text, Prompt |
|
||||
| **KI-Ausgabe** | KI-Bild |
|
||||
| **Layout** | Gruppe, Frame, Notiz, Compare |
|
||||
|
||||
### KI-Integration
|
||||
- OpenRouter als primäre AI-Schicht
|
||||
- 9 Image-Modelle (Gemini, FLUX, GPT-5, etc.)
|
||||
- Self-hosted KI-Services (rembg, Real-ESRGAN, GFPGAN)
|
||||
|
||||
### UX-Prinzipien
|
||||
- Node-Status-Modell: `idle → executing → done | error`
|
||||
- Skeleton-Nodes für Agent-Workflows
|
||||
- Browser Notifications (opt-in)
|
||||
|
||||
## Tech Stack
|
||||
|
||||
| Bereich | Technologie |
|
||||
|---------|-------------|
|
||||
| Frontend | Next.js 16 + Tailwind v4 + ShadCN/UI |
|
||||
| Canvas | @xyflow/react + dnd-kit |
|
||||
| Backend | Convex (Self-hosted) |
|
||||
| Auth | Better Auth |
|
||||
| AI | OpenRouter |
|
||||
| Payment | Lemon Squeezy |
|
||||
| Cache | Redis |
|
||||
| Analytics | Rybbit |
|
||||
| Email | Unsend + Stalwart |
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
### Voraussetzungen
|
||||
|
||||
- Node.js 20+
|
||||
- pnpm
|
||||
- Docker (für Self-Hosted)
|
||||
- Convex Backend
|
||||
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
# Repository klonen
|
||||
git clone https://github.com/lemonspace/lemonspace-web.git
|
||||
cd lemonspace-web
|
||||
|
||||
# Dependencies installieren
|
||||
pnpm install
|
||||
|
||||
# Environment-Variables kopieren
|
||||
cp .env.example .env.local
|
||||
|
||||
# Entwicklungsserver starten
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
### Environment Variables
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
```env
|
||||
# Convex
|
||||
CONVEX_DEPLOYMENT=your-deployment-name
|
||||
NEXT_PUBLIC_CONVEX_URL=https://your-convex-instance.convex.cloud
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
||||
# Better Auth
|
||||
BETTER_AUTH_SECRET=your-secret-key
|
||||
BETTER_AUTH_URL=http://localhost:3000
|
||||
|
||||
## Learn More
|
||||
# OpenRouter
|
||||
OPENROUTER_API_KEY=your-openrouter-key
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
# Lemon Squeezy
|
||||
LEMONSQUEEZY_API_KEY=your-key
|
||||
LEMONSQUEEZY_WEBHOOK_SECRET=your-webhook-secret
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
# Redis
|
||||
REDIS_URL=redis://localhost:6379
|
||||
```
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
||||
## Self-Hosting
|
||||
|
||||
## Deploy on Vercel
|
||||
Self-Hosting richtet sich an technisch versierte Nutzer. Für alle anderen empfehlen wir die gehostete Version unter [lemonspace.app](https://lemonspace.app).
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
```bash
|
||||
# Docker Compose
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
||||
Das Self-Hosting-Paket umfasst:
|
||||
- `docker-compose.yml` — Alle Services
|
||||
- `.env.example` — Umgebungsvariablen
|
||||
- Setup-README — Schritt-für-Schritt-Anleitung
|
||||
|
||||
## Pricing
|
||||
|
||||
| Tier | Preis/Monat | Credits | Zielgruppe |
|
||||
|------|-------------|---------|------------|
|
||||
| Free | €0 | €0,50 | Testen & Evaluieren |
|
||||
| Starter | €9 | €6,30 | Einzelnutzer |
|
||||
| Pro | €49 | €36,02 | Aktive Creator |
|
||||
| Business | €99 | €76,23 | Teams |
|
||||
|
||||
## Projektstruktur
|
||||
|
||||
```
|
||||
lemonspace-web/
|
||||
├── app/ # Next.js App Router
|
||||
├── components/ # React-Komponenten
|
||||
│ ├── ui/ # ShadCN/UI Komponenten
|
||||
│ ├── canvas/ # Canvas-Komponenten
|
||||
│ └── nodes/ # Node-Komponenten
|
||||
├── convex/ # Convex Schema & Functions
|
||||
├── lib/ # Utility-Funktionen
|
||||
├── hooks/ # React Hooks
|
||||
└── types/ # TypeScript-Typen
|
||||
```
|
||||
|
||||
## Roadmap
|
||||
|
||||
### Phase 1 — Foundation (MVP)
|
||||
- [x] Projektsetup
|
||||
- [ ] Canvas mit @xyflow/react
|
||||
- [ ] Bild-Upload & KI-Generierung
|
||||
- [ ] Credit-System
|
||||
- [ ] Lemon Squeezy Integration
|
||||
|
||||
### Phase 2 — KI-Features
|
||||
- [ ] Alle 9 Image-Modelle
|
||||
- [ ] Agent Nodes
|
||||
- [ ] Transformation Nodes (BG entfernen, Upscale)
|
||||
- [ ] Compare-Node
|
||||
|
||||
### Phase 3 — Kollaboration
|
||||
- [ ] Echtzeit-Kollaboration
|
||||
- [ ] Kommentar-System
|
||||
- [ ] Versions-History
|
||||
- [ ] Export-Funktionen
|
||||
|
||||
## Lizenz
|
||||
|
||||
LemonSpace ist **Source Available**, nicht Open Source.
|
||||
|
||||
| Nutzung | Lizenz | Kosten |
|
||||
|---------|--------|--------|
|
||||
| Privat / Persönlich | BSL 1.1 | Kostenlos |
|
||||
| Kommerziell Self-Host | Separate Lizenz | TBD |
|
||||
| Gehostete Version | Abo | €9–99/Monat |
|
||||
|
||||
**BSL 1.1 mit 3-Jahres-Change-Date zu Apache 2.0**
|
||||
|
||||
Siehe [LICENSE.md](./LICENSE.md) für Details.
|
||||
|
||||
## Mitwirken
|
||||
|
||||
Beiträge sind willkommen! Bitte öffnen Sie einen Pull Request oder ein Issue.
|
||||
|
||||
### Entwicklungs-Richtlinien
|
||||
- Conventional Commits
|
||||
- TypeScript strict mode
|
||||
- Tests für neue Features
|
||||
|
||||
## Support
|
||||
|
||||
- **Dokumentation:** [docs.lemonspace.io](https://docs.lemonspace.io)
|
||||
- **Issues:** [GitHub Issues](https://github.com/lemonspace/lemonspace-web/issues)
|
||||
- **Email:** support@lemonspace.io
|
||||
|
||||
## Kontakt
|
||||
|
||||
- **Website:** [lemonspace.io](https://lemonspace.io)
|
||||
- **App:** [app.lemonspace.io](https://app.lemonspace.io)
|
||||
- **Email:** hello@lemonspace.io
|
||||
- **Lizenzanfragen:** licensing@lemonspace.io
|
||||
|
||||
---
|
||||
|
||||
*LemonSpace — From raw image to campaign-ready in minutes, not hours.*
|
||||
|
||||
Reference in New Issue
Block a user