Revise README for Kuki SaaS project details
Updated README to enhance project description and features.
This commit is contained in:
@@ -1,2 +1,46 @@
|
|||||||
# kuki-saas
|
# 🍪 Kuki SaaS - Cookie Consent Solution
|
||||||
Lightweight, customizable cookie consent management widget and backend API.
|
A lightweight, GDPR/CCPA compliant Cookie Consent banner widget, management dashboard, and backend API.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Features
|
||||||
|
|
||||||
|
- **⚡ Ultra-lightweight Client (`kuki.js`):** Vanilla JS under 10KB with Shadow DOM isolation.
|
||||||
|
- **🛡️ Privacy & Compliance:** GDPR, CCPA, and ePrivacy directive ready.
|
||||||
|
- **🐳 Dockerized Infrastructure:** One-command startup using PostgreSQL and Redis.
|
||||||
|
- **⚡ Fast API:** High-performance backend for consent logging and license verification.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🛠️ Project Structure
|
||||||
|
|
||||||
|
```text
|
||||||
|
kuki-saas/
|
||||||
|
├── client/ # Lightweight embeddable JavaScript widget (kuki.js)
|
||||||
|
├── backend/ # Node.js / Go API for consent & user settings
|
||||||
|
├── docker-compose.yml # Infrastructure setup (PostgreSQL, Redis)
|
||||||
|
└── README.md # Documentation
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## ⚙️ Quick Start (Development)
|
||||||
|
|
||||||
|
1. Clone the repository
|
||||||
|
```Bash
|
||||||
|
git clone [https://github.com/YOUR_USERNAME/kuki-saas.git](https://github.com/YOUR_USERNAME/kuki-saas.git)
|
||||||
|
cd kuki-saas
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Start Services with Docker
|
||||||
|
```Bash
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Verify Containers
|
||||||
|
```Bash
|
||||||
|
docker ps
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📝 License
|
||||||
|
|
||||||
|
Proprietary - All rights reserved.
|
||||||
|
|||||||
Reference in New Issue
Block a user