Para ejecutar este proyecto, necesitarás:
Después de clonar el proyecto, necesitarás instalar las dependencias del proyecto. Navega al directorio del proyecto y ejecuta el siguiente comando:
Necesitas ejecutar.
npm ci
Esto asegura que uses las dependencias exactas.
npm install
Tip
Si se ejecuta con docker, el contenedor instalara las dependencias automáticamente.
Este proyecto utiliza las siguientes dependencias clave:
- Next.js - El marco de React para producción.
- React - Una biblioteca de JavaScript para construir interfaces de usuario.
- React DOM - Sirve como el punto de entrada a los renderizadores del DOM y del servidor para React.
- ESLint - Una herramienta de linting configurable y enchufable para identificar e informar sobre patrones en JavaScript.
- Prettier - Un formateador de código con opiniones.
- Jest - Un marco de pruebas de JavaScript con un enfoque en la simplicidad.
- Docker - Un conjunto de productos de plataforma como servicio que utilizan virtualización a nivel de sistema operativo para entregar software en paquetes llamados contenedores.
Para asegurar la calidad del código, este proyecto utiliza ESLint para el linting y Prettier para el formateo del código. Asegúrate de ejecutar el linter y el formateador antes de hacer commit:
npm run lint
npm run pre-commit
Para ejecutar las pruebas, usa el siguiente comando:
npm test
Primero, ejecuta el servidor de desarrollo:
npm run dev
# o
yarn dev
# o
pnpm dev
Tip
Para correr el proyecto con docker, usar el siguiente comando: docker compose up --build
Abre http://localhost:3000 con tu navegador para ver el resultado.
Puedes empezar a editar la página modificando pages/index.js
. La página se actualiza automáticamente a medida que editas el archivo.
Las rutas de la API se pueden acceder en http://localhost:3000/api/hello. Este endpoint se puede editar en pages/api/hello.js
.
El directorio pages/api
está mapeado a /api/*
. Los archivos en este directorio se tratan como rutas de la API en lugar de páginas de React.
Este proyecto utiliza next/font
para optimizar y cargar automáticamente Inter, una fuente personalizada de Google.
- Crea una rama. Nómbrala correctamente con los estándares de "Convención de nombres de ramas de Git" si es posible. Por ejemplo:
feat/nombre
: Una nueva característica
fix/nombre
: Una corrección de error
dox/nombre
: Cambios en la documentación
style/nombre
: Cambios que no afectan al código (formateo)
refactor/nombre
: Para cualquier refactorización.
test/
: Añadir pruebas faltantes o corregir pruebas existentes - Haz tus cambios en tu rama. Usa la convención simplificada de commit
- Prueba tus cambios para asegurarte de que no rompen nada.
- Envía una solicitud de extracción con tus cambios.
Todo el código debe ser revisado y aceptado por al menos 2 participantes antes de fusionarse en master
Para aprender más sobre Next.js, echa un vistazo a los siguientes recursos:
- Documentación de Next.js - aprende sobre las características y la API de Next.js.
- Aprende Next.js - un tutorial interactivo de Next.js.
Puedes echar un vistazo al repositorio de GitHub de Next.js - ¡tus comentarios y contribuciones son bienvenidos!
La forma más fácil de desplegar tu aplicación Next.js es utilizar la Plataforma Vercel de los creadores de Next.js.
Consulta nuestra documentación de despliegue de Next.js para más detalles.