Plantilla de README de proyecto¶
Copiar esta estructura en el README.md de cada repositorio.
# Nombre del proyecto
Descripción de una o dos líneas.
## Qué es
Propósito y contexto dentro de la plataforma.
## Stack
- Lenguaje y versión.
- Framework principal.
- Base de datos, caché y cola.
- Runtime de producción.
## Arquitectura
Breve mapa de carpetas y responsabilidades. Enlazar a documentación más detallada.
## Requisitos
- Versiones necesarias.
- Servicios externos.
## Instalación local
```sh
cp .env.example .env
composer install
php artisan key:generate
php artisan migrate
Comandos¶
| Comando | Descripción |
|---|---|
... |
... |
Tests¶
php artisan test
Deploy¶
Rama, pipeline y verificación posterior.
Documentación¶
- VortexPlay Docs
- Contrato de API:
docs/api-contract.md - Changelog:
CHANGELOG.md
Responsables¶
Nombre o equipo. ```