Reordenando ficheros y subida de documentacion
This commit is contained in:
164
README.md
164
README.md
@@ -1,100 +1,108 @@
|
||||
# Reformix — Landing Page
|
||||
# Reformix
|
||||
|
||||
> Landing page pública de **Reformix**, la plataforma que conecta a propietarios con reformistas de confianza. Presupuesto en 5 minutos, render por WhatsApp. Construida con **Next.js + TypeScript + Tailwind CSS v4**.
|
||||
> SaaS para reformistas en España. El cliente final del reformista deja sus datos en una landing, sube fotos de su cocina o baño, recibe en menos de 2 minutos una llamada de un agente IA desde un número fijo de su provincia, y al colgar recibe por WhatsApp un render IA del espacio reformado + presupuesto orientativo desglosado con el branding del reformista.
|
||||
|
||||
## 🚀 Inicio rápido
|
||||
|
||||
```bash
|
||||
# Instalar dependencias
|
||||
npm install
|
||||
|
||||
# Iniciar servidor de desarrollo
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Abre [http://localhost:3000](http://localhost:3000) en tu navegador para ver el resultado.
|
||||
**Estado:** planificación completa, código sin empezar. Equipo de 4 personas, 3 semanas (24-may → 11-jun) hasta demo MVP.
|
||||
|
||||
---
|
||||
|
||||
## 🛠 Stack tecnológico
|
||||
## Empezar aquí
|
||||
|
||||
| Capa | Tecnología |
|
||||
Si eres una **persona o agente IA nuevo en el proyecto**, lee en este orden:
|
||||
|
||||
1. [`CLAUDE.md`](CLAUDE.md) — Onboarding para agentes IA + comandos + convenciones (también útil para humanos)
|
||||
2. [`specs.md`](specs.md) — Requisitos formales (55 RF + 30 RNF en notación EARS)
|
||||
3. [`docs/dev-strategy.md`](docs/dev-strategy.md) — Cómo se va a construir (orden, equipo, milestones)
|
||||
4. [`devdocs/plan.md`](devdocs/plan.md) — Plan vivo de implementación
|
||||
5. [`devdocs/progress.md`](devdocs/progress.md) — Estado actual
|
||||
|
||||
---
|
||||
|
||||
## Índice de documentación
|
||||
|
||||
### Producto y diseño
|
||||
|
||||
| Doc | Para qué |
|
||||
|---|---|
|
||||
| Framework | Next.js (App Router) |
|
||||
| Lenguaje | TypeScript 5 |
|
||||
| Estilos | Tailwind CSS v4 (`@import "tailwindcss"` + `@theme`) |
|
||||
| Componentes | React 19 (Server + Client Components) |
|
||||
| Fuente | Inter (Google Fonts, variable) |
|
||||
| [`specs.md`](specs.md) | Requisitos funcionales y no funcionales en EARS |
|
||||
| [`funnel.md`](funnel.md) | Diagrama del funnel punta a punta (ASCII + Mermaid + descripción Miro) |
|
||||
| [`copy/COPY-GUIDE.md`](copy/COPY-GUIDE.md) | TODO el copy del producto (landings, agente voz, WhatsApp, emails) |
|
||||
| [`design/design-system.md`](design/design-system.md) | Sistema de diseño, identidad visual y verbal |
|
||||
| [`design/design-tokens.css`](design/design-tokens.css) | Tokens CSS custom properties |
|
||||
| [`design/tailwind.config.ext.js`](design/tailwind.config.ext.js) | Extensión config Tailwind |
|
||||
|
||||
---
|
||||
### Negocio
|
||||
|
||||
## 📁 Arquitectura del proyecto
|
||||
|
||||
```text
|
||||
landing-page/
|
||||
├── src/
|
||||
│ ├── app/
|
||||
│ │ ├── globals.css # Design system: @theme tokens + @layer utilities
|
||||
│ │ ├── layout.tsx # Root layout con fuente Inter y meta tags
|
||||
│ │ └── page.tsx # Composición de página — solo imports de componentes
|
||||
│ │
|
||||
│ └── components/
|
||||
│ ├── Navbar/ # Barra de navegación (actualmente comentada)
|
||||
│ ├── Hero/ # Sección principal: headline + LeadForm interno
|
||||
│ ├── ReformaSlider/ # Comparador antes/después interactivo (drag)
|
||||
│ ├── Features/ # Sección "Cómo funciona" — 3 pasos numerados
|
||||
│ ├── Pricing/ # Tabla de servicios: Presupuesto · Reforma · Integral
|
||||
│ ├── ContactForm/ # Formulario de contacto con validación y testimonial
|
||||
│ └── Footer/ # Links, redes sociales y copyright
|
||||
```
|
||||
|
||||
### Convención de componentes
|
||||
|
||||
- Cada componente vive en su propia carpeta `ComponentName/ComponentName.tsx`.
|
||||
- Los sub-componentes de uso exclusivo (ej. `LeadForm`) se definen en el mismo archivo del padre, **no** como archivos separados.
|
||||
- `page.tsx` solo importa componentes de primer nivel — sin JSX estructural inline.
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Design System
|
||||
|
||||
Definido en `globals.css` mediante el bloque `@theme` de Tailwind v4:
|
||||
|
||||
- **Colores:** Escala negro/blanco de alto contraste. Sin acentos de color innecesarios.
|
||||
- **Tipografía:** Inter variable — pesos 400 a 900, tracking ajustado para headlines impactantes.
|
||||
- **Animaciones:** Entrada por scroll con `IntersectionObserver` + clase `reveal`. Micro-interacciones en hovers de cards y botones.
|
||||
- **Responsive:** Mobile-first. Grid de 1 columna en móvil, 2–3 en desktop.
|
||||
|
||||
---
|
||||
|
||||
## 🧩 Secciones de la landing
|
||||
|
||||
| Sección | Descripción |
|
||||
| Doc | Para qué |
|
||||
|---|---|
|
||||
| **Hero** | Headline + formulario de captación de lead (nombre, email, empresa, teléfono) |
|
||||
| **ReformaSlider** | Comparador antes/después con drag handle — 3 espacios: Cocina, Baño, Salón |
|
||||
| **Features** | Explicación del proceso en 3 pasos: llama → foto → presupuesto |
|
||||
| **Pricing** | 3 niveles de servicio con toggle mensual/anual y features detalladas |
|
||||
| **ContactForm** | Formulario completo con datos de contacto y testimonial de cliente real |
|
||||
| **Footer** | Links de navegación, redes sociales, estado operativo y copyright |
|
||||
| [`negocio/README.md`](negocio/README.md) | Resumen ejecutivo (1 página) |
|
||||
| [`negocio/modelo-negocio.md`](negocio/modelo-negocio.md) | Pricing, unit economics, competencia |
|
||||
| [`negocio/operaciones.md`](negocio/operaciones.md) | Stack, proveedores, onboarding reformista |
|
||||
| [`negocio/equipo.md`](negocio/equipo.md) | Roles del equipo + plan contratación |
|
||||
| [`negocio/legal.md`](negocio/legal.md) | RGPD, LSSI-CE, Lista Robinson, AI Act, Verifactu |
|
||||
| [`negocio/plan-financiero.md`](negocio/plan-financiero.md) | Proyecciones 3 escenarios |
|
||||
| [`negocio/roadmap.md`](negocio/roadmap.md) | Hitos por fase (hasta 18 meses) |
|
||||
| [`negocio/riesgos.md`](negocio/riesgos.md) | Matriz de riesgos + contingencias |
|
||||
| [`negocio/datos/`](negocio/datos/) | Costes desglosados, proveedores, KPIs |
|
||||
| [`investigacion-competencia-internacional.md`](investigacion-competencia-internacional.md) | Mapa de competidores + analogías (~5k palabras) |
|
||||
|
||||
### Desarrollo (código futuro)
|
||||
|
||||
| Doc | Para qué |
|
||||
|---|---|
|
||||
| [`CLAUDE.md`](CLAUDE.md) | Onboarding para agentes IA |
|
||||
| [`docs/dev-strategy.md`](docs/dev-strategy.md) | Estrategia de desarrollo, estructura, milestones |
|
||||
| [`devdocs/plan.md`](devdocs/plan.md) | Plan de implementación vivo |
|
||||
| [`devdocs/progress.md`](devdocs/progress.md) | Estado real |
|
||||
| [`devdocs/decisions.md`](devdocs/decisions.md) | Decisiones arquitectónicas (ADRs ligeros) |
|
||||
|
||||
---
|
||||
|
||||
## 📝 Scripts disponibles
|
||||
## Stack técnico (resumen)
|
||||
|
||||
```bash
|
||||
npm run dev # Desarrollo con Turbopack (hot reload)
|
||||
npm run build # Build de producción optimizado
|
||||
npm run start # Servidor de producción con la build generada
|
||||
npm run lint # ESLint — análisis estático del código
|
||||
```
|
||||
Frontend + Backend: Next.js 14 (App Router) → Vercel
|
||||
UI: Tailwind + shadcn/ui
|
||||
Agente de voz: Retell.ai + ElevenLabs (ES)
|
||||
Telefonía: Zadarma (fijos provinciales)
|
||||
WhatsApp: Evolution API (primario) / WA Business API (respaldo)
|
||||
Render IA: Nano Banana 2 / Image 2 (+ Replicate fallback)
|
||||
IA texto + vision: GPT-4o
|
||||
DB: Postgres + Drizzle ORM
|
||||
Storage: S3 (Cloudflare R2)
|
||||
Email: SMTP
|
||||
Analytics: PostHog
|
||||
Testing: Vitest + Playwright
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Repositorio
|
||||
## Equipo
|
||||
|
||||
GitHub: [McGregory99/reformix-hackaton](https://github.com/McGregory99/reformix-hackaton)
|
||||
| Persona | Owner |
|
||||
|---|---|
|
||||
| **Carlos** | Producto + Voz agent + WhatsApp + Coordinación |
|
||||
| **Simon** | Backend + IA pipeline + WhatsApp + SEO |
|
||||
| **Goyo** | Motor de presupuesto + Dominio sector + Datos reales |
|
||||
| **Antonio** | UI/UX + Creativos de ads |
|
||||
|
||||
---
|
||||
|
||||
*Desarrollado para el hackathon interno de Reformix.*
|
||||
## Milestones
|
||||
|
||||
| ID | Descripción | Fecha |
|
||||
|---|---|---|
|
||||
| M0 | Setup compartido | 24-may |
|
||||
| M1 | Landings B2B + B2C live + ads activos | **28-may** 🎯 |
|
||||
| M2 | Agente de voz validado | 30-may |
|
||||
| M3 | Pipeline IA end-to-end | 4-jun |
|
||||
| M4 | Panel reformista funcional | 6-jun |
|
||||
| M5 | QA con 20 leads | 7-jun |
|
||||
| M6 | Plan B grabado + ensayo demo | 9-jun |
|
||||
| M7 | **Demo MVP** | **11-jun** 🎯 |
|
||||
|
||||
---
|
||||
|
||||
## Licencia
|
||||
|
||||
Privado / propietario hasta nuevo aviso.
|
||||
|
||||
Reference in New Issue
Block a user