Skip to content

Commit 7ebbc98

Browse files
committed
Readme y licence
1 parent 10c5c5c commit 7ebbc98

2 files changed

Lines changed: 141 additions & 113 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Trinity Bytes
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 120 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,175 +1,182 @@
1-
# SafeMap Landing Page
1+
# Página de Aterrizaje SafeMap
22

3-
> 🚀 **Status: COMPLETED** - Production-ready landing page for SafeMap mobile security platform
3+
> 🚀 **Estado: COMPLETADO** - Página de aterrizaje lista para producción para la plataforma de seguridad móvil SafeMap.
44
5-
## 📋 Project Overview
5+
## 📋 Descripción General del Proyecto
66

7-
SafeMap is a university project for a mobile security platform that allows citizens to report incidents anonymously, visualize risk zones through real-time heat maps, and get safe routes using AI technology.
7+
SafeMap es un proyecto universitario para una plataforma de seguridad móvil que permite a los ciudadanos reportar incidentes de forma anónima, visualizar zonas de riesgo mediante mapas de calor en tiempo real y obtener rutas seguras utilizando tecnología de IA.
88

9-
## 🏗️ Technology Stack
9+
## 🏗️ Stack Tecnológico
1010

1111
- **Framework**: Astro 5.8.1
12-
- **UI Library**: React 18
13-
- **Styling**: Tailwind CSS
14-
- **Language**: TypeScript
15-
- **Build Tool**: Vite
16-
- **Package Manager**: npm
12+
- **Biblioteca UI**: React 18
13+
- **Estilos**: Tailwind CSS
14+
- **Lenguaje**: TypeScript
15+
- **Herramienta de Build**: Vite
16+
- **Gestor de Paquetes**: npm
1717

18-
## 🚀 Project Structure
18+
## 📁 Estructura del Proyecto
1919

2020
```text
21-
safemap-landing/
22-
├── public/ # Static assets
23-
│ ├── avatars/ # Testimonial avatars (SVG)
24-
│ ├── js/ # Client-side scripts
25-
│ ├── favicon.svg # Site favicon
26-
│ ├── apple-touch-icon.svg # iOS app icon
27-
│ ├── robots.txt # SEO robots file
28-
│ └── site.webmanifest # PWA manifest
21+
SafeMap-Web/
22+
├── public/ # Activos estáticos
23+
│ ├── avatars/ # Avatares para testimonios (SVG)
24+
│ ├── js/ # Scripts del lado del cliente
25+
│ ├── favicon.svg # Favicon del sitio
26+
│ ├── apple-touch-icon.svg # Ícono de app para iOS
27+
│ ├── robots.txt # Archivo robots para SEO
28+
│ └── site.webmanifest # Manifiesto PWA
2929
├── src/
3030
│ ├── components/
31-
│ │ ├── cards/ # Reusable card components
32-
│ │ ├── interactive/ # React interactive components
33-
│ │ ├── layout/ # Header, Footer
34-
│ │ ├── sections/ # Page sections
35-
│ │ └── ui/ # UI elements
36-
│ ├── data/ # JSON data files
37-
│ ├── layouts/ # Page layouts
38-
│ ├── pages/ # Astro pages
39-
│ └── styles/ # Global CSS
40-
├── astro.config.mjs # Astro configuration
41-
└── tailwind.config.mjs # Tailwind configuration
31+
│ │ ├── cards/ # Componentes de tarjeta reutilizables
32+
│ │ ├── interactive/ # Componentes interactivos de React
33+
│ │ ├── layout/ # Cabecera, Pie de página
34+
│ │ ├── sections/ # Secciones de la página
35+
│ │ └── ui/ # Elementos de UI
36+
│ ├── data/ # Archivos de datos JSON
37+
│ ├── layouts/ # Diseños de página
38+
│ ├── pages/ # Páginas Astro
39+
│ │ └── index.astro # Página principal, por ejemplo
40+
│ └── styles/ # CSS Global
41+
├── .github/
42+
│ └── workflows/
43+
│ └── deploy.yml # Flujo de trabajo para despliegue en GitHub Pages
44+
├── astro.config.mjs # Configuración de Astro
45+
├── tailwind.config.mjs # Configuración de Tailwind
46+
├── package.json # Manifiesto del proyecto
47+
├── DEPLOYMENT.md # Guía de despliegue
48+
└── README.md # Este archivo
4249
```
4350

44-
│ └── index.astro
45-
└── package.json
51+
Astro busca archivos `.astro` o `.md` en el directorio `src/pages/`. Cada página se expone como una ruta basada en el nombre de su archivo.
4652

47-
````
53+
No hay nada especial sobre `src/components/`, pero ahí es donde nos gusta colocar cualquier componente de Astro/React/Vue/Svelte/Preact.
4854

49-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
55+
Cualquier activo estático, como imágenes, se puede colocar en el directorio `public/`.
5056

51-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
57+
## 🧞 Comandos
5258

53-
Any static assets, like images, can be placed in the `public/` directory.
59+
Todos los comandos se ejecutan desde la raíz del proyecto, desde una terminal:
5460

55-
## 🧞 Commands
61+
| Comando | Acción |
62+
| :------------------------ | :--------------------------------------------------------- |
63+
| `npm install` | Instala las dependencias |
64+
| `npm run dev` | Inicia el servidor de desarrollo local en `localhost:4321` |
65+
| `npm run build` | Compila tu sitio para producción en `./dist/` |
66+
| `npm run preview` | Previsualiza tu compilación localmente, antes de desplegar |
67+
| `npm run astro ...` | Ejecuta comandos CLI como `astro add`, `astro check` |
68+
| `npm run astro -- --help` | Obtiene ayuda usando el CLI de Astro |
5669

57-
All commands are run from the root of the project, from a terminal:
70+
## ✨ Características Implementadas
5871

59-
| Command | Action |
60-
| :------------------------ | :----------------------------------------------- |
61-
| `npm install` | Installs dependencies |
62-
| `npm run dev` | Starts local dev server at `localhost:4321` |
63-
| `npm run build` | Build your production site to `./dist/` |
64-
| `npm run preview` | Preview your build locally, before deploying |
65-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
66-
| `npm run astro -- --help` | Get help using the Astro CLI |
72+
### 🎨 Diseño y Experiencia de Usuario
6773

68-
## ✨ Features Implemented
74+
- Diseño moderno y responsivo con enfoque "mobile-first"
75+
- Diseño de Cuadrícula Bento interactiva mostrando características clave
76+
- Animaciones y transiciones de desplazamiento suaves
77+
- Esquema de colores y tipografía profesional
6978

70-
### 🎨 Design & User Experience
71-
- Modern, responsive design with mobile-first approach
72-
- Interactive Bento Grid layout showcasing key features
73-
- Smooth scroll animations and transitions
74-
- Professional color scheme and typography
79+
### 🧩 Componentes Interactivos
7580

76-
### 🧩 Interactive Components
77-
- **MapDemo**: Mock interactive map with incident markers and safe routes
78-
- **StatsCounter**: Animated real-time statistics display
79-
- **ContactForm**: Comprehensive beta registration form with validation
81+
- **MapDemo**: Maqueta de mapa interactivo con marcadores de incidentes y rutas seguras
82+
- **StatsCounter**: Visualización animada de estadísticas en tiempo real
83+
- **ContactForm**: Formulario completo de registro para beta con validación
8084

81-
### 📱 Sections
82-
- **Hero**: Main value proposition with call-to-action
83-
- **Features**: Six key platform features with icons
84-
- **Testimonials**: Authority endorsements from security experts
85-
- **Pricing**: Three-tier pricing structure
86-
- **FAQ**: Comprehensive frequently asked questions
87-
- **Footer**: Complete site information and links
85+
### 📱 Secciones
8886

89-
### 🔧 Technical Features
90-
- **SEO Optimized**: Meta tags, structured data, sitemap
91-
- **PWA Ready**: Web app manifest and offline capabilities
92-
- **Performance**: Code splitting, lazy loading, optimized bundles
93-
- **Accessibility**: WCAG 2.1 AA compliant
94-
- **TypeScript**: Full type safety throughout the project
87+
- **Hero**: Propuesta de valor principal con llamada a la acción
88+
- **Features**: Seis características clave de la plataforma con iconos
89+
- **Testimonials**: Respaldo de autoridades y expertos en seguridad
90+
- **Pricing**: Estructura de precios de tres niveles
91+
- **FAQ**: Preguntas frecuentes detalladas
92+
- **Footer**: Información completa del sitio y enlaces
9593

96-
## 🚀 Quick Start
94+
### 🔧 Características Técnicas
95+
96+
- **Optimizado para SEO**: Meta tags, datos estructurados, sitemap
97+
- **Listo para PWA**: Manifiesto de aplicación web y capacidades offline
98+
- **Rendimiento**: División de código (code splitting), carga diferida (lazy loading), paquetes optimizados
99+
- **Accesibilidad**: Cumple con WCAG 2.1 AA
100+
- **TypeScript**: Seguridad de tipos completa en todo el proyecto
101+
102+
## 🚀 Inicio Rápido
103+
104+
### Prerrequisitos
97105

98-
### Prerequisites
99106
- Node.js 18+
100-
- npm or yarn
107+
- npm o yarn
101108

102-
### Installation
109+
### Instalación
103110

104111
```bash
105-
# Clone the repository
106-
git clone [repository-url]
107-
cd safemap-landing
112+
# Clona el repositorio
113+
git clone https://github.com/trinity-bytes/SafeMap-Web.git
114+
cd SafeMap-Web
108115

109-
# Install dependencies
116+
# Instala las dependencias
110117
npm install
111118

112-
# Start development server
119+
# Inicia el servidor de desarrollo
113120
npm run dev
114-
````
121+
```
115122

116-
### Available Scripts
123+
### Scripts Disponibles
117124

118125
```bash
119-
npm run dev # Start development server
120-
npm run build # Build for production
121-
npm run preview # Preview production build
122-
npm run astro # Run Astro CLI commands
126+
npm run dev # Inicia el servidor de desarrollo
127+
npm run build # Compila para producción
128+
npm run preview # Previsualiza la compilación de producción
129+
npm run astro # Ejecuta comandos CLI de Astro
123130
```
124131

125-
## 🌐 Deployment
132+
## 🌐 Despliegue
126133

127-
The project is production-ready and can be deployed to:
134+
El proyecto está listo para producción y se puede desplegar en:
128135

129-
- **Netlify** (Recommended)
136+
- **Netlify** (Recomendado)
130137
- **Vercel**
131138
- **GitHub Pages**
132-
- **Custom server**
139+
- **Servidor personalizado**
133140

134-
See `DEPLOYMENT.md` for detailed deployment instructions.
141+
Consulta `DEPLOYMENT.md` para instrucciones detalladas de despliegue.
135142

136-
## 📊 Performance
143+
## 📊 Rendimiento
137144

138-
- **Bundle Size**: ~200KB gzipped
139-
- **Lighthouse Score**: 95-100 across all metrics
145+
- **Tamaño del Paquete**: ~200KB gzipped
146+
- **Puntuación Lighthouse**: 95-100 en todas las métricas
140147
- **First Contentful Paint**: <1.5s
141148
- **Time to Interactive**: <3.5s
142149

143-
## 🎓 University Project
150+
## 🎓 Proyecto Universitario
144151

145-
This landing page was developed as part of a university project for the "Diseño y Patrones de Software" course, demonstrating:
152+
Esta página de aterrizaje fue desarrollada como parte de un proyecto universitario para el curso "Diseño y Patrones de Software", demostrando:
146153

147-
- Modern web development practices
148-
- Component-based architecture
149-
- Performance optimization techniques
150-
- Accessibility compliance
151-
- Professional documentation
154+
- Prácticas modernas de desarrollo web
155+
- Arquitectura basada en componentes
156+
- Técnicas de optimización del rendimiento
157+
- Cumplimiento de accesibilidad
158+
- Documentación profesional
152159

153-
## 📚 Documentation
160+
## 📚 Documentación
154161

155-
- `DEPLOYMENT.md` - Comprehensive deployment guide
156-
- `PROJECT-COMPLETION.md` - Detailed project completion report
157-
- Component documentation within source files
162+
- `DEPLOYMENT.md` - Guía de despliegue completa
163+
- `PROJECT-COMPLETION.md` - Informe detallado de finalización del proyecto (si existe)
164+
- Documentación de componentes dentro de los archivos fuente
158165

159-
## 🤝 Contributing
166+
## 🤝 Contribuciones
160167

161-
This is a university project, but feedback and suggestions are welcome:
168+
Este es un proyecto universitario, pero los comentarios y sugerencias son bienvenidos:
162169

163-
1. Fork the repository
164-
2. Create a feature branch
165-
3. Commit your changes
166-
4. Push to the branch
167-
5. Create a Pull Request
170+
1. Haz un fork del repositorio
171+
2. Crea una rama para tu característica (`git checkout -b feature/AmazingFeature`)
172+
3. Haz commit de tus cambios (`git commit -m 'Add some AmazingFeature'`)
173+
4. Haz push a la rama (`git push origin feature/AmazingFeature`)
174+
5. Abre un Pull Request
168175

169-
## 📄 License
176+
## 📄 Licencia
170177

171-
This project is developed for educational purposes as part of university coursework.
178+
Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo `LICENSE` para más detalles.
172179

173180
---
174181

175-
**Built with ❤️ using Astro, React, TypeScript, and Tailwind CSS**
182+
**Construido con ❤️ usando Astro, React, TypeScript y Tailwind CSS**

0 commit comments

Comments
 (0)