Skip to content

Commit 116b8e4

Browse files
authored
Update README.md
1 parent b327a9d commit 116b8e4

File tree

1 file changed

+55
-77
lines changed

1 file changed

+55
-77
lines changed

README.md

Lines changed: 55 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,32 @@
22

33
![PyDay Banner](public/images/banner-og.jpg)
44

5-
**The official frontend for PyDay Chile** - A community-driven Python conference showcasing Chile's tech talent through talks, workshops, and networking events across multiple cities.
5+
**The official frontend for PyDay Chile** – a community-driven Python conference showcasing Chiles tech talent through talks, workshops, and networking events across multiple cities.
66

77
## ✨ Key Features
88

99
### 📍 Multi-City Experience
10-
- Dynamic content routing for different conference locations
11-
- Interactive map showing participating cities
12-
- City-specific schedules and venue information
10+
- Dynamic content routing for different conference locations
11+
- Interactive map showing participating cities
12+
- City-specific schedules and venue details
1313

1414
### 📸 Multimedia Hub
15-
- Responsive image gallery with lazy loading
16-
- Full-screen modal viewer with keyboard navigation
17-
- Organized historical content by year/location
18-
- Embedded video section with responsive players
15+
- Responsive image gallery with lazy loading
16+
- Full-screen modal viewer with keyboard navigation
17+
- Organized historical content by year and location
18+
- Embedded video section with responsive players
1919

2020
### 🚀 Modern Web Practices
21-
- Next.js 13+ App Router implementation
22-
- Optimized WebP image delivery
23-
- Responsive UI with Tailwind CSS
24-
- Accessibility-first components (ARIA labels, keyboard nav)
21+
- Next.js 13+ App Router implementation
22+
- Optimized WebP image delivery
23+
- Responsive UI built with Tailwind CSS
24+
- Accessibility-first components (ARIA labels, keyboard navigation)
2525

2626
### 🎤 Event Features
27-
- Speaker profiles with social links
28-
- Interactive schedule with filtering
29-
- Sponsor showcase with tiered visibility
30-
- Registration form with validation
27+
- Speaker profiles with social links
28+
- Interactive schedule with filtering
29+
- Sponsor showcase with tiered visibility
30+
- Registration form with client-side validation
3131

3232
## 🛠 Tech Stack
3333

@@ -64,89 +64,67 @@ pyday-frontend/
6464
└── tailwind.config.js # Custom design system
6565
```
6666

67-
6867
## 🖼 Image Optimization
6968

70-
| Feature | Implementation | Benefit |
71-
|------------------------|------------------------------|----------------------------------|
72-
| **Modern Formats** | WebP conversion | 30% smaller than JPEG |
73-
| **Responsive SrcSet** | Next.js Image component | Device-appropriate sizes |
74-
| **Lazy Loading** | Intersection Observer API | Faster initial load |
75-
| **Blur Placeholders** | Dynamic SVG generation | Smooth loading experience |
69+
| Feature | Implementation | Benefit |
70+
|-----------------------|-----------------------------|-------------------------------|
71+
| **Modern Formats** | WebP conversion | 30% smaller than JPEG |
72+
| **Responsive SrcSet** | Next.js Image component | Device-appropriate sizes |
73+
| **Lazy Loading** | Intersection Observer API | Faster initial load |
74+
| **Blur Placeholders** | Dynamic SVG generation | Smooth loading experience |
7675

7776
## ♿ Accessibility Commitment
7877

79-
- WCAG 2.1 AA compliant components
80-
- Semantic HTML structure
81-
- Keyboard-navigable interfaces
82-
- Reduced motion preferences support
83-
- ARIA labels for interactive elements
78+
- WCAG 2.1 AA-compliant components
79+
- Semantic HTML structure
80+
- Keyboard-navigable interfaces
81+
- Reduced-motion preference support
82+
- ARIA labels for interactive elements
8483

8584
## 📌 Core Dependencies
8685

87-
- `[email protected]`: React framework for production
88-
- `[email protected]`: Utility-first CSS
89-
- `[email protected]`: Smooth animations
90-
86+
- `[email protected]`: React framework for production
87+
- `[email protected]`: Utility-first CSS
88+
- `[email protected]`: Smooth animations
9189

9290
## 🚦 Feature Management
9391

94-
Controla la visibilidad de funcionalidades mediante variables de entorno:
92+
Control feature visibility via environment variables:
9593

9694
```env
9795
# .env.local
98-
NEXT_PUBLIC_FEATURE_REGISTRATION="false" # Formulario de registro general
99-
NEXT_PUBLIC_FEATURE_SPONSORS="true" # Sección completa de patrocinios
100-
NEXT_PUBLIC_FEATURE_SPONSOR_FORM="false" # Formulario de patrocinio específico
101-
```
102-
103-
### Variables Disponibles
104-
| Variable | Descripción | Valores Válidos |
105-
|-----------------------------------|----------------------------------------------|-----------------|
106-
| `NEXT_PUBLIC_FEATURE_REGISTRATION` | Habilita formulario de registro principal | `true`/`false` |
107-
| `NEXT_PUBLIC_FEATURE_SPONSORS` | Muestra sección completa de patrocinios | `true`/`false` |
108-
| `NEXT_PUBLIC_FEATURE_SPONSOR_FORM` | Activa formulario de contacto para patrocinios | `true`/`false` |
109-
110-
### Flujo de Trabajo Recomendado
111-
1. **Configurar variables** en `.env.local` (usar `true`/`false`)
112-
2. **Reiniciar servidor** después de cambios
113-
3. **Los CTAs alternativos** se mostrarán automáticamente cuando:
114-
- Una funcionalidad está deshabilitada (`false`)
115-
- Existe un link externo configurado en `cityData.js`
116-
117-
### Para Links Externos
118-
```javascript
119-
// Ejemplo en src/data/cities.js
120-
valparaiso: {
121-
talkProposalLink: "https://..." // URL válida habilita CTA automático
122-
}
96+
NEXT_PUBLIC_FEATURE_REGISTRATION="false" # Main registration form
97+
NEXT_PUBLIC_FEATURE_SPONSORS="true" # Full sponsors section
98+
NEXT_PUBLIC_FEATURE_SPONSOR_FORM="false" # Individual sponsor inquiry form
12399
```
124100

125-
**Nota:** Los botones alternativos (CTAs) se muestran solo cuando:
126-
- La variable correspondiente está en `false`
127-
- Existe un link configurado en los datos de la ciudad
101+
### Available Variables
128102

129-
**Cambios realizados:**
130-
1. Sección dedicada a gestión de features
131-
2. Tabla clara de variables
132-
3. Explicación del comportamiento automático
133-
4. Ejemplo práctico de configuración
134-
5. Guía visual para no técnicos
103+
| Variable | Description | Valid Values |
104+
|-----------------------------------|--------------------------------------------|---------------|
105+
| `NEXT_PUBLIC_FEATURE_REGISTRATION` | Enables main registration form | `true`/`false` |
106+
| `NEXT_PUBLIC_FEATURE_SPONSORS` | Shows full sponsors section | `true`/`false` |
107+
| `NEXT_PUBLIC_FEATURE_SPONSOR_FORM` | Activates sponsor inquiry form | `true`/`false` |
135108

109+
### Recommended Workflow
136110

137-
**Version final del archivo .env.local:**
138-
```env
139-
# CONFIGURACIÓN DE FUNCIONALIDADES
140-
# Valores permitidos: "true" (activado) | "false" (desactivado)
111+
1. **Set variables** in `.env.local` using `true`/`false`.
112+
2. **Restart the server** after any changes.
113+
3. **Alternate CTAs** automatically display when:
114+
- A feature is disabled (`false`)
115+
- An external link is provided in `cityData.js`
141116

142-
NEXT_PUBLIC_FEATURE_REGISTRATION="false"
143-
NEXT_PUBLIC_FEATURE_SPONSORS="true"
144-
NEXT_PUBLIC_FEATURE_SPONSOR_FORM="false"
117+
### External Link Configuration
145118

146-
# URL BASE DEL SITIO (no modificar en desarrollo)
147-
NEXT_PUBLIC_SITE_URL="http://localhost:3000"
119+
```javascript
120+
// Example in src/data/cities.js
121+
valparaiso: {
122+
talkProposalLink: "https://..." // Valid URL enables automatic CTA
123+
}
148124
```
149125

126+
> **Note:** Alternate CTAs appear only when the related feature flag is `false` and a link is configured for that city.
127+
150128
## 🌍 Contributing
151129

152130
We welcome community contributions! Please see our [Contribution Guidelines](docs/CONTRIBUTING.md) and review our [Photography Style Guide](docs/guia-fotografia.md) for asset submissions.
@@ -155,4 +133,4 @@ We welcome community contributions! Please see our [Contribution Guidelines](doc
155133

156134
**License**: Apache 2.0 (See [LICENSE](LICENSE))
157135
**Maintainer**: PyDay Chile Tech Committee
158-
136+

0 commit comments

Comments
 (0)