docs: add SECURITY.md and API_KEYS.md documentation
- Create SECURITY.md with vulnerability reporting policy - Add environment variables & secrets best practices - Document input validation and rate limiting strategies - Create docs/API_KEYS.md with step-by-step API credential guides - IGDB OAuth 2.0 via Twitch setup - RAWG API key simple registration - TheGamesDB API key registration - Update README.md with security and API configuration sections - Add tests/documentation.spec.ts with 12 validation tests
This commit is contained in:
18
README.md
18
README.md
@@ -11,6 +11,24 @@ Quasar es una aplicación web para al gestión de una biblioteca personal de vid
|
||||
- **Búsqueda Avanzada**: Filtros para encontrar juegos rápidamente según diferentes criterios.
|
||||
- **Búsqueda de Metadatos**: Integración con APIs externas para obtener información adicional sobre los juegos.
|
||||
|
||||
## Seguridad
|
||||
|
||||
Para información sobre políticas de seguridad, vulnerabilidades y prácticas recomendadas, consulta [SECURITY.md](SECURITY.md).
|
||||
|
||||
## Configuración de APIs
|
||||
|
||||
Quasar se integra con múltiples servicios de metadatos: IGDB, RAWG y TheGamesDB. Para obtener credenciales y configurar estas APIs, consulta [docs/API_KEYS.md](docs/API_KEYS.md).
|
||||
|
||||
### Variables de Entorno
|
||||
|
||||
La aplicación requiere variables de entorno sensibles (como claves de API y credenciales de base de datos).
|
||||
Usa `.env.local` o `.env.{NODE_ENV}.local` para desarrollo. **Nunca** hagas commit de archivos `.env` al repositorio:
|
||||
|
||||
```bash
|
||||
cp .env.example .env.local
|
||||
# Edita .env.local con tus credenciales
|
||||
```
|
||||
|
||||
## Otros proyectos relacionados, para coger ideas y funcionalidades
|
||||
|
||||
| Herramienta | Categoría | Descripción | Features Destacadas | Ideal Para | Enlace Oficial |
|
||||
|
||||
Reference in New Issue
Block a user