From 39528687126ce8ba10f3529818bd4c1a09282121 Mon Sep 17 00:00:00 2001 From: Valknar XXX Date: Sun, 26 Oct 2025 09:35:35 +0100 Subject: [PATCH] docs: beate uhse for freedom --- README.md | 388 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 268 insertions(+), 120 deletions(-) diff --git a/README.md b/README.md index 2734d66..0b44be2 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,162 @@ -# sexy.pivoine.art +# ๐Ÿ’‹ sexy.pivoine.art -An adult content platform built with SvelteKit, Directus CMS, and hardware integration via Buttplug.io. +
-[![Build and Push Docker Image](https://github.com/valknarxxx/sexy/actions/workflows/docker-build-push.yml/badge.svg)](https://github.com/valknarxxx/sexy/actions/workflows/docker-build-push.yml) -[![Docker Image Security Scan](https://github.com/valknarxxx/sexy/actions/workflows/docker-scan.yml/badge.svg)](https://github.com/valknarxxx/sexy/actions/workflows/docker-scan.yml) +![Beate Uhse Flying](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExdGh2ZjBrY2xvYXB0aGN6OWp4YzR4Y3doNzJoZ3J3ZjNqMGx4YzRhZCZlcD12MV9naWZzX3NlYXJjaCZjdD1n/3o6Zt6ML6BklcajjsA/giphy.gif) -## Quick Start +*"Lust und Liebe gehรถren zusammen - wer das eine verteufelt, zerstรถrt auch das andere."* +โ€” **Beate Uhse**, Pionierin der sexuellen Befreiung โœˆ๏ธ -### Using Docker (Recommended) +--- + +### ๐Ÿ† An Intimate Platform for Liberation & Pleasure ๐Ÿ† + +Built with passion, technology, and the fearless spirit of sexual empowerment + +[![Build Status](https://img.shields.io/github/actions/workflow/status/valknarxxx/sexy.pivoine.art/docker-build-push.yml?style=for-the-badge&logo=docker&logoColor=white&color=FF69B4&labelColor=8B008B)](https://github.com/valknarxxx/sexy.pivoine.art/actions/workflows/docker-build-push.yml) +[![Security Scan](https://img.shields.io/github/actions/workflow/status/valknarxxx/sexy.pivoine.art/docker-scan.yml?style=for-the-badge&logo=security&logoColor=white&label=Security&color=DA70D6&labelColor=8B008B)](https://github.com/valknarxxx/sexy.pivoine.art/actions/workflows/docker-scan.yml) +[![License](https://img.shields.io/badge/License-For_Pleasure-FF1493?style=for-the-badge&logo=heart&logoColor=white&labelColor=8B008B)](LICENSE) +[![Made with Love](https://img.shields.io/badge/Made_with-๐Ÿ’œ_Love-FF69B4?style=for-the-badge&labelColor=8B008B)](http://sexy.pivoine.art) + +
+ +--- + +## ๐Ÿ‘… What Is This Delicious Creation? + +Welcome, dear pleasure-seeker! This is **sexy.pivoine.art** โ€” a modern, sensual platform combining the elegance of **SvelteKit**, the power of **Directus CMS**, and the intimate connection of **Buttplug.io** hardware integration. + +Like Beate Uhse breaking barriers in post-war Germany, we believe in the freedom to explore, create, and celebrate sexuality without shame. This platform is built for **models**, **creators**, and **connoisseurs** of adult content who deserve technology as sophisticated as their desires. + +### โ™‰ Features That'll Make You Blush โ™Š + +- ๐Ÿ’– **Sensual SvelteKit Frontend** with Tailwind CSS 4 styling +- ๐Ÿ—„๏ธ **Headless CMS** powered by Directus for content liberation +- ๐ŸŽฎ **Hardware Integration** via Buttplug.io (yes, really!) +- ๐ŸŒ **Multi-Platform Support** (AMD64 + ARM64) โ€” pleasure everywhere +- ๐Ÿ”’ **Session-Based Authentication** โ€” discretion guaranteed +- ๐Ÿ“ฑ **Responsive Design** that looks sexy on any device +- ๐ŸŒ **Internationalization** โ€” pleasure speaks all languages +- ๐Ÿ“Š **Analytics Integration** (Umami) โ€” know your admirers +- ๐Ÿ“ง **Newsletter Integration** (Letterspace) โ€” stay connected + +
+ +### ๐Ÿ‘ Technology Stack ๐Ÿ‘ + +
+ +``` +โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” +โ”‚ ๐Ÿ’‹ Frontend Layer โ”‚ +โ”‚ โ”œโ”€ SvelteKit 2.0 โ†’ Smooth as silk โ”‚ +โ”‚ โ”œโ”€ Tailwind CSS 4 โ†’ Styled to seduce โ”‚ +โ”‚ โ”œโ”€ bits-ui Components โ†’ Building blocks of pleasure โ”‚ +โ”‚ โ””โ”€ Vite โ†’ Fast and furious โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ ๐Ÿท Backend Layer โ”‚ +โ”‚ โ”œโ”€ Directus CMS โ†’ Content with no limits โ”‚ +โ”‚ โ”œโ”€ Custom Extensions โ†’ Bespoke pleasures โ”‚ +โ”‚ โ””โ”€ PostgreSQL โ†’ Data deep and secure โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ ๐ŸŽ€ Hardware Layer โ”‚ +โ”‚ โ”œโ”€ Buttplug.io โ†’ Real connections โ”‚ +โ”‚ โ”œโ”€ TypeScript + Rust โ†’ Power and precision โ”‚ +โ”‚ โ””โ”€ WebBluetooth API โ†’ Wireless intimacy โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ ๐ŸŒธ DevOps Layer โ”‚ +โ”‚ โ”œโ”€ Docker โ†’ Containerized ecstasy โ”‚ +โ”‚ โ”œโ”€ GitHub Actions โ†’ Automated seduction โ”‚ +โ”‚ โ””โ”€ GHCR โ†’ Images served hot โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ +``` + +--- + +## ๐Ÿ”ฅ Quick Start โ€” Get Intimate Fast + +### ๐Ÿ’• Option 1: Using Docker (Recommended) ```bash -# Pull and run the latest image +# Pull the pleasure docker pull ghcr.io/valknarxxx/sexy:latest + +# Run with passion docker run -d -p 3000:3000 \ -e PUBLIC_API_URL=https://api.your-domain.com \ -e PUBLIC_URL=https://your-domain.com \ ghcr.io/valknarxxx/sexy:latest + +# Visit your creation at http://localhost:3000 ๐Ÿ’‹ ``` -See [QUICKSTART.md](QUICKSTART.md) for detailed instructions. +See [QUICKSTART.md](QUICKSTART.md) for the full seduction guide. -### Local Development +### ๐Ÿ’œ Option 2: Local Development **Prerequisites:** -1. Install Node.js 20.19.1 -2. Enable corepack: `corepack enable` -3. Install dependencies: `pnpm install` -4. Install Rust and wasm-bindgen: `cargo install wasm-bindgen-cli` +1. Node.js 20.19.1 โ€” *the foundation* +2. `corepack enable` โ€” *unlock the tools* +3. `pnpm install` โ€” *gather your ingredients* +4. Rust + `cargo install wasm-bindgen-cli` โ€” *forge the connection* -**Start development environment:** +**Start your pleasure journey:** ```bash -# Start all services (Docker Compose + frontend) +# Awaken all services pnpm dev -# Or start individually -pnpm dev:data # Start data services -pnpm dev:directus # Start Directus CMS -pnpm --filter @sexy.pivoine.art/frontend dev # Start frontend +# Or tease them one by one +pnpm dev:data # The foundation +pnpm dev:directus # The content +pnpm --filter @sexy.pivoine.art/frontend dev # The face ``` -Access the application at `http://localhost:3000` +Visit `http://localhost:3000` and let the experience begin... ๐Ÿ’‹ -## Project Structure +--- -This is a pnpm monorepo with three packages: +## ๐ŸŒน Project Structure -- **`packages/frontend`** - SvelteKit application with Tailwind CSS 4 -- **`packages/bundle`** - Directus extensions (endpoints, hooks, themes) -- **`packages/buttplug`** - Hardware control library (TypeScript + Rust/WASM) +This monorepo contains three packages, each serving its purpose: -## Documentation +``` +sexy.pivoine.art/ +โ”œโ”€ ๐Ÿ’„ packages/frontend/ โ†’ SvelteKit app (the seduction) +โ”œโ”€ ๐ŸŽญ packages/bundle/ โ†’ Directus extensions (the power) +โ””โ”€ ๐ŸŽฎ packages/buttplug/ โ†’ Hardware control (the connection) +``` -- **[QUICKSTART.md](QUICKSTART.md)** - Get running in 5 minutes with Docker -- **[DOCKER.md](DOCKER.md)** - Comprehensive Docker deployment guide -- **[CLAUDE.md](CLAUDE.md)** - Development guide and architecture -- **[.github/workflows/README.md](.github/workflows/README.md)** - CI/CD workflows +--- -## Building +## ๐Ÿ“š Documentation โ€” Your Guide to Pleasure + +
+ +| Document | Purpose | Emoji | +|----------|---------|-------| +| [QUICKSTART.md](QUICKSTART.md) | Get wet... I mean, get started! | ๐Ÿ’ฆ | +| [DOCKER.md](DOCKER.md) | Complete deployment manual | ๐Ÿณ | +| [CLAUDE.md](CLAUDE.md) | Architecture & development | ๐Ÿค– | +| [.github/workflows/README.md](.github/workflows/README.md) | CI/CD workflows | โš™๏ธ | + +
+ +--- + +## ๐ŸŽจ Building โ€” Craft Your Masterpiece ### Build All Packages ```bash +# Prepare everything pnpm install + +# Build the WASM foundation pnpm --filter @sexy.pivoine.art/buttplug build:wasm + +# Build the packages pnpm --filter @sexy.pivoine.art/buttplug build pnpm --filter @sexy.pivoine.art/frontend build pnpm --filter @sexy.pivoine.art/bundle build @@ -73,102 +165,114 @@ pnpm --filter @sexy.pivoine.art/bundle build ### Build Docker Image ```bash -# Using the build script +# Quick build ./build.sh -# Or manually +# Manual control docker build -t sexy.pivoine.art:latest . -# Multi-platform +# Multi-platform pleasure docker buildx build --platform linux/amd64,linux/arm64 -t sexy.pivoine.art:latest . ``` -## Deployment +--- + +## ๐Ÿš€ Deployment โ€” Share Your Creation ### Production with Docker ```bash -# Using docker-compose +# Configure your secrets cp .env.production.example .env.production -# Edit .env.production with your values +# Edit .env.production with your intimate details + +# Deploy with grace docker-compose -f docker-compose.production.yml up -d ``` ### Production without Docker ```bash -# Build all packages +# Build everything pnpm build:frontend -# Start the server +# Start serving pnpm --filter @sexy.pivoine.art/frontend start ``` -## Features +--- -- ๐ŸŽจ Modern SvelteKit frontend with Tailwind CSS 4 -- ๐Ÿ—„๏ธ Headless CMS powered by Directus -- ๐ŸŽฎ Hardware integration via Buttplug.io -- ๐ŸŒ Multi-platform support (AMD64/ARM64) -- ๐Ÿ”’ Session-based authentication -- ๐Ÿ“ฑ Responsive design with bits-ui components -- ๐ŸŒ Internationalization support (i18n) -- ๐Ÿ“Š Built-in analytics integration (Umami) -- ๐Ÿ“ง Newsletter integration (Letterspace) +## ๐ŸŒˆ Environment Variables -## Technology Stack +### ๐Ÿ’– Required (The Essentials) -### Frontend -- **Framework:** SvelteKit 2 -- **Styling:** Tailwind CSS 4 -- **UI Components:** bits-ui, custom component library -- **Build Tool:** Vite -- **Deployment:** Node.js adapter +- `PUBLIC_API_URL` โ€” Your Directus backend +- `PUBLIC_URL` โ€” Your frontend domain -### Backend -- **CMS:** Directus (headless) -- **Extensions:** Custom endpoints, hooks, and themes -- **Database:** PostgreSQL (via Directus) +### ๐Ÿ’œ Optional (The Extras) -### Hardware -- **Library:** Buttplug.io -- **Languages:** TypeScript + Rust (compiled to WASM) -- **Protocols:** WebBluetooth API +- `PUBLIC_UMAMI_ID` โ€” Analytics tracking +- `LETTERSPACE_API_URL` โ€” Newsletter endpoint +- `LETTERSPACE_API_KEY` โ€” Newsletter key +- `LETTERSPACE_LIST_ID` โ€” Mailing list -### DevOps -- **Containerization:** Docker + Docker Compose -- **CI/CD:** GitHub Actions -- **Registry:** GitHub Container Registry (GHCR) -- **Security:** Trivy vulnerability scanning +See [.env.production.example](.env.production.example) for the full configuration. -## Environment Variables +--- -### Required +## ๐ŸŽญ Development Workflow -- `PUBLIC_API_URL` - Directus API endpoint -- `PUBLIC_URL` - Frontend application URL +```mermaid +graph LR + A[๐Ÿ’ก Idea] --> B[๐Ÿ’ป Code] + B --> C[๐Ÿงช Test Locally] + C --> D[๐ŸŒฟ Feature Branch] + D --> E[๐Ÿ“ค Push & PR] + E --> F{โœ… CI Pass?} + F -->|Yes| G[๐Ÿ”€ Merge to Main] + F -->|No| B + G --> H[๐Ÿš€ Auto Deploy] + H --> I[๐Ÿท๏ธ Tag Release] + I --> J[๐ŸŽ‰ Celebrate] +``` -### Optional +1. Create โ†’ `git checkout -b feature/my-sexy-feature` +2. Develop โ†’ Write beautiful code +3. Test โ†’ `pnpm dev` +4. Push โ†’ Create PR (triggers CI build) +5. Merge โ†’ Automatic deployment to production +6. Release โ†’ `git tag v1.0.0 && git push origin v1.0.0` -- `PUBLIC_UMAMI_ID` - Umami analytics tracking ID -- `LETTERSPACE_API_URL` - Newsletter API endpoint -- `LETTERSPACE_API_KEY` - Newsletter API key -- `LETTERSPACE_LIST_ID` - Mailing list identifier +--- -See [.env.production.example](.env.production.example) for full reference. +## ๐Ÿ” Security โ€” Protected Pleasure -## Development Workflow +- ๐Ÿ›ก๏ธ Daily vulnerability scans with Trivy +- ๐Ÿ”’ Non-root Docker containers +- ๐Ÿ“Š Security reports in GitHub Security tab +- ๐Ÿค Confidential issue reporting available -1. Make changes to code -2. Test locally with `pnpm dev` -3. Create a feature branch -4. Push and create PR (triggers CI build) -5. Merge to `main` (triggers production build) -6. Tag release: `git tag v1.0.0 && git push origin v1.0.0` +*Report security concerns privately via GitHub Security.* -## CI/CD Pipeline +--- -Automated workflows handle: +## ๐Ÿ’ Contributing โ€” Join the Movement + +Like Beate Uhse fought for sexual liberation, we welcome contributors who believe in freedom, pleasure, and quality code. + +1. **Fork** this repository +2. **Create** your feature branch +3. **Commit** your changes +4. **Push** to your branch +5. **Submit** a pull request + +All contributors are bound by our code of conduct: **Respect, Consent, and Quality.** + +--- + +## ๐ŸŽฏ CI/CD Pipeline โ€” Automated Seduction + +Our GitHub Actions workflows handle: - โœ… Multi-platform Docker builds (AMD64 + ARM64) - โœ… Automated publishing to GHCR @@ -176,38 +280,82 @@ Automated workflows handle: - โœ… Weekly cleanup of old images - โœ… Semantic versioning from git tags -Images are available at: `ghcr.io/valknarxxx/sexy` - -## Contributing - -1. Fork the repository -2. Create a feature branch -3. Make your changes -4. Ensure tests pass (when implemented) -5. Submit a pull request - -## Security - -- Docker images are scanned daily for vulnerabilities -- Security reports available in GitHub Security tab -- Report security issues privately via GitHub Security - -## License - -See [LICENSE](LICENSE) file for details. - -## Support - -- **Issues:** [GitHub Issues](https://github.com/valknarxxx/sexy/issues) -- **Discussions:** [GitHub Discussions](https://github.com/valknarxxx/sexy/discussions) - -## Acknowledgments - -- Built with [SvelteKit](https://kit.svelte.dev/) -- Powered by [Directus](https://directus.io/) -- Hardware control via [Buttplug.io](https://buttplug.io/) -- UI components from [bits-ui](https://www.bits-ui.com/) +**Images available at:** `ghcr.io/valknarxxx/sexy` --- -**Note:** This is an adult content platform. Users must be 18+ or the age of majority in their jurisdiction. +## ๐Ÿ’Œ Credits & Acknowledgments + +
+ +### ๐ŸŒธ Created with Love by ๐ŸŒธ + +**[Palina](http://sexy.pivoine.art) & [Valknar](http://sexy.pivoine.art)** + +*Fรผr die Mรคuse...* ๐Ÿญ๐Ÿ’• + +--- + +### ๐Ÿ™ Built With + +| Technology | Purpose | +|------------|---------| +| [SvelteKit](https://kit.svelte.dev/) | Framework | +| [Directus](https://directus.io/) | CMS | +| [Buttplug.io](https://buttplug.io/) | Hardware | +| [bits-ui](https://www.bits-ui.com/) | Components | + +--- + +### ๐Ÿ’ Inspired by Beate Uhse + +Pioneer of sexual liberation (1919-2001) +Pilot, Entrepreneur, Freedom Fighter + +*"Eine Frau, die ihre Sexualitรคt selbstbestimmt lebt, ist eine freie Frau."* + +![Beate Uhse Quote](https://img.shields.io/badge/Beate_Uhse-Sexual_Liberation_Pioneer-FF1493?style=for-the-badge&logo=heart&logoColor=white&labelColor=8B008B) + +
+ +--- + +## โš–๏ธ License & Legal + +- ๐Ÿ“œ See [LICENSE](LICENSE) file for details +- ๐Ÿ”ž **18+ Only** โ€” This platform is for adults +- ๐ŸŒ Users must be of legal age in their jurisdiction +- โš–๏ธ We support equality, freedom, and consensual pleasure + +--- + +## ๐Ÿ’ฌ Support & Community + +
+ +[![Issues](https://img.shields.io/badge/๐Ÿ›_Issues-Report_Here-FF69B4?style=for-the-badge&labelColor=8B008B)](https://github.com/valknarxxx/sexy.pivoine.art/issues) +[![Discussions](https://img.shields.io/badge/๐Ÿ’ญ_Discussions-Join_Here-DA70D6?style=for-the-badge&labelColor=8B008B)](https://github.com/valknarxxx/sexy.pivoine.art/discussions) +[![Website](https://img.shields.io/badge/๐ŸŒ_Website-Visit_Here-FF1493?style=for-the-badge&labelColor=8B008B)](http://sexy.pivoine.art) + +
+ +--- + +
+ +### ๐Ÿ‘ Made with ๐Ÿ’œ for Freedom, Pleasure & Technology ๐Ÿ‘ + +``` + โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•— โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•— โ–ˆโ–ˆโ•— +โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ• โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•โ•šโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•โ•šโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ•”โ• +โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ•šโ–ˆโ–ˆโ–ˆโ•”โ• โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ• + โ•šโ•โ•โ•โ–ˆโ–ˆโ•— โ–ˆโ–ˆโ•”โ•โ•โ• โ–ˆโ–ˆโ•”โ–ˆโ–ˆโ•— โ•šโ–ˆโ–ˆโ•”โ• +โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ• โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•โ•šโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ•‘ +โ•šโ•โ•โ•โ•โ•โ• โ•šโ•โ•โ•โ•โ•โ•โ•โ•šโ•โ• โ•šโ•โ• โ•šโ•โ• +``` + +*Pleasure is a human right. Technology is freedom. Together, they are power.* + +**[sexy.pivoine.art](http://sexy.pivoine.art)** | ยฉ 2025 Palina & Valknar + +