@boostapp/core 🚀

¡Bienvenido! 🎉
Este framework está diseñado para que puedas crear proyectos frontend rápidamente bajo la estructura organizada y eficiente de BoostApp. Con él, tendrás todas las configuraciones necesarias para iniciar un proyecto con Next.js sin complicaciones.

🎯 ¿Qué incluye este framework?

Este framework te proporciona una estructura de carpetas bien definida y una serie de configuraciones básicas para comenzar a desarrollar de manera ágil y productiva. ¡Solo instala, configura, y estarás listo para ponerte a trabajar! Aquí te explicamos en detalle cada parte:

📂 Estructura de carpetas

• migraciones/: Aquí irán los queries y la creación de las bases de datos, manteniendo un historial completo de los cambios que se hacen en la base de datos. De esta forma, cualquier persona que retome el proyecto podrá tener una visión clara del estado de la base de datos tal como tú la tienes. 🛠️

• public/: Carpeta básica de Next.js donde irán los archivos estáticos públicos, como imágenes, íconos o fuentes. Perfecto para los activos que necesiten ser accesibles desde la URL pública. 🌐

• src/: Contiene todo el código fuente del proyecto Next.js. Aquí es donde sucede la magia. ✨

  • app/: La aplicación principal de Next.js basada en el App Directory de Next.js 14.

    • (plataforma): Aquí es donde organizamos la sección administrativa del proyecto. Por convención en BoostApp, el login y todas las rutas protegidas suelen redirigirse al /dashboard. Es una buena práctica para mantener el proyecto ordenado. 😉
      • dashboard/: Este es el punto de inicio, el "index" de la parte protegida del sistema. Una vez que el usuario inicie sesión, esta es la primera pantalla que verá. A partir de aquí, puedes organizar tu estructura de carpetas según lo que necesites en el proyecto.
    • layout.tsx: El archivo principal que define el layout de toda la plataforma. Es el contenedor global de las vistas administrativas.
    • Plataforma.module.css: Aquí se encuentran los estilos CSS del layout de la plataforma. Mantén todo limpio y estilizado. 🎨

  • api/: Los endpoints de tu proyecto estarán aquí. Es parte esencial de Next.js, permitiendo crear API Routes de manera sencilla.

    • [...nextauth]: Este es el archivo de configuración para la autenticación básica mediante NextAuth con correo y contraseña. Si necesitas agregar más proveedores, este es el lugar ideal para hacerlo. 🔒
    • signup: Endpoint para registrar nuevos usuarios.

  • auth/: Aquí están las rutas y páginas relacionadas con la autenticación del proyecto.

    • signin/: Página para el inicio de sesión. Los usuarios podrán ingresar a la plataforma desde aquí.
    • signup/: Página para el registro de nuevos usuarios. 📝

  • common/: Aquí se ubican todos los archivos comunes que utilizarás a lo largo del proyecto, tales como utilidades, hooks, conexiones a la base de datos, enums, interfaces, etc. Mantén todo bien organizado por módulos. 🗂️

  • components/: En esta carpeta, se guardan los componentes de cliente que se utilizarán en el proyecto. La idea es que todo esté debidamente ordenado por módulo, para facilitar el desarrollo y el mantenimiento del código. 📦
    Por defecto, también encontrarás el layout del menú de la parte protegida o administrativa, que te permitirá gestionar la navegación en la sección administrativa del proyecto sin complicaciones.

• .env: Este archivo contiene las variables de entorno básicas necesarias para iniciar el proyecto de manera local, en producción o qa. 🔑

• .eslintrc.json: Configuraciones básicas de ESLint, proporcionadas por el equipo de BoostApp. Te ayudará a mantener un código limpio y libre de errores. 🧹

• .prettierrc: Configuraciones de Prettier para asegurarte de que todo el código esté bien formateado de acuerdo con los estándares de BoostApp. ✨

• Dockerfile: Un archivo de configuración para crear un contenedor Docker de tu proyecto Next.js. Útil si deseas empaquetar tu aplicación y mantener un entorno de desarrollo consistente. 🐋

• next.config.mjs: Configuraciones básicas de Next.js ajustadas para un funcionamiento óptimo con BoostApp. 🚀

• Otros archivos: Los archivos restantes en el proyecto son los básicos de Next.js que te ayudarán a mantener el proyecto en marcha sin problemas.

⚙️ Variables de entorno

Para que tu proyecto funcione correctamente, necesitas configurar las siguientes variables de entorno. Asegúrate de proporcionar los valores adecuados para cada una:

#DB
PGSQL_USER=""
PGSQL_PASSWORD=""
ENVIRONMENT=""  //(Valores posibles: dev, qa, prod)
PGSQL_HOST=""
PGSQL_HOST_QA=""
PGSQL_PORT=""
PGSQL_DATABASE=""

#NEXTAUTH
NEXTAUTH_SECRET=secret

🛠️ Instalación

Instalar este framework es muy sencillo. Solo necesitas ejecutar el siguiente comando en tu terminal:

npx @boostapp/core nombre-del-proyecto

Este comando:

1. Creará un nuevo proyecto con el nombre que indiques.
2. Instalará todas las dependencias necesarias.
3. Configurará el proyecto con la estructura básica y lista para que puedas comenzar a desarrollar.

🎉 ¡Manos a la obra!

🚀 ¡Esperamos que este framework te agilice tu proceso de desarrollo y te permita enfocarte en lo que realmente importa: crear cosas increíbles! Siéntete libre de personalizarlo según tus necesidades y recuerda que siempre estamos mejorando para ofrecerte la mejor experiencia de desarrollo posible. 💪

🍵 ¡Ve por un café, ponte cómodo y ha ensuciarse las manos! 😊