8d56fe392d
- Modified `.env.example` to reflect new API URL structure and added CDN configuration for external storage. - Updated `.gitignore` to include deployment secrets and certificate files, ensuring sensitive information is not committed. - Revised `BACKEND_INTEGRATION.md` to clarify authentication methods, replacing Cognito references with Nostr NIP-98. - Deleted outdated documentation files (`CONTENT-INTEGRATION-COMPLETE.md`, `CURSOR-MCP-SETUP.md`, `FINAL-STATUS.md`, `FIXES-APPLIED.md`, `INDEEHHUB-INTEGRATION.md`, `PROJECT-COMPLETE.md`, `PROJECT-SUMMARY.md`) to streamline project documentation. These changes enhance the clarity of the environment setup and improve the overall documentation structure for better developer onboarding.
62 lines
2.0 KiB
Markdown
62 lines
2.0 KiB
Markdown
# IndeeHub
|
|
|
|
A decentralized streaming platform for independent films built with Vue 3, Nostr authentication, glassmorphic UI, and PWA capabilities.
|
|
|
|
## Quick Start
|
|
|
|
### Development (frontend only)
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
Open http://localhost:5174. The app runs with mock data by default. No backend required.
|
|
|
|
### Full stack (frontend + backend)
|
|
|
|
```bash
|
|
# Option A: Docker Compose
|
|
docker compose -f docker-compose.dev.yml up
|
|
|
|
# Option B: Script (starts Postgres, Redis, MinIO, backend, frontend)
|
|
bash scripts/dev.sh
|
|
```
|
|
|
|
See [ARCHITECTURE.md](ARCHITECTURE.md) for a quick stack comparison, [docs/ARCHITECTURE.html](docs/ARCHITECTURE.html) for the full document with pros/cons, and [DEPLOYMENT.md](DEPLOYMENT.md) for production deployment.
|
|
|
|
## Features
|
|
|
|
- **Nostr auth** — Extension (NIP-07), Remote Signer (NIP-46), or Private Key
|
|
- **Glassmorphic UI** — Browse with content rows, modals
|
|
- **Lightning payments** — BTCPay Server for subscriptions, rentals, zaps
|
|
- **PWA** — Install as native app on mobile/desktop
|
|
- **Responsive** — Mobile-first design
|
|
|
|
## Auth Options
|
|
|
|
| Method | Description |
|
|
|--------|-------------|
|
|
| Extension | NIP-07 browser extension (Alby, nos2x) |
|
|
| Remote Signer | NIP-46 — QR code (desktop) or link (mobile) to Primal, Amber, etc. |
|
|
| Private Key | Paste nsec for direct sign-in |
|
|
|
|
## Commands
|
|
|
|
```bash
|
|
npm run dev # Dev server (port 5174)
|
|
npm run build # Production build
|
|
npm run type-check # TypeScript validation
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- [ARCHITECTURE.md](ARCHITECTURE.md) — Quick stack comparison; [docs/ARCHITECTURE.html](docs/ARCHITECTURE.html) — Full doc with pros/cons
|
|
- [DEPLOYMENT.md](DEPLOYMENT.md) — Production deployment (Docker, Portainer)
|
|
- [DEV_AUTH.md](DEV_AUTH.md) — Development mode auth
|
|
- [BACKEND_INTEGRATION.md](BACKEND_INTEGRATION.md) — Backend API integration
|
|
|
|
## Tech Stack
|
|
|
|
Vue 3 • TypeScript • Tailwind CSS • Vite • Pinia • Nostr (NIP-07, NIP-46, NIP-98) • BTCPay • MinIO
|