Developars.club

Plataforma Open Source de perfiles de desarrollo. Creada por y para la comunidad.

Con propósitos educativos con la idea de crear un producto.

¿Cómo está estructurado el código?

Este proyecto utiliza Turborepo para manejar los paquetes de forma monorepo. Cada paquete tiene su propia documentación y se encuentra en la carpeta packages. Las aplicaciones se encuentran en la carpeta apps.

Este turborepo usa npm como package manager. Incluye los siguientes packages/apps:

Apps y Paquetes

web: Aplicación Next.js. Frontend de la plataforma
eslint-config-custom: Configuraciones de eslint (incluye eslint-config-next y eslint-config-prettier)
tsconfig: fichero tsconfig.jsons usado en el monorepo

Utilidades

Este turborepo tiene algunas herramientas adicionales añadidas y configuradas.

TypeScript para el tipado estático.
ESLint para el linting.
Prettier para el formateo de código.

Build

Para construir el proyecto, se debe ejecutar el siguiente comando:

cd my-turborepo
npm run build

Develop

Para desarrollar el proyecto, se debe ejecutar el siguiente comando:

cd my-turborepo
npm run dev

Test

Para lanzar los tests end-to-end de la app, tienes dos formas. Si los quieres lanzar en modo gráfico, ejecuta:

npm run test:e2e:open

Si los quieres lanzar en modo consola, ejecuta:

npm run test:e2e

Recuerda tener abierta la aplicación en otra terminal con npm run dev para que los tests puedan ejecutarse.

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd my-turborepo
npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

npx turbo link

¿Cómo contribuir al proyecto?

Es un proyecto open source, por lo que cualquier persona puede contribuir. Para ello, se debe seguir el siguiente flujo de trabajo:

Crear un fork del proyecto.
Crear una rama con el nombre de la feature que se va a implementar.
Crear un PR con la feature implementada.
Se revisará el PR y se sugerirán los cambios necesarios si es preciso.
Se harán los cambios necesarios y se volverá a revisar el PR.
Se hará merge del PR.
Tu contribución será añadida al proyecto.

Dale un vistazo a la guía de contribución para más información.

Links útiles

A continuación se listan algunos links útiles para el desarrollo de este proyecto:

PintaApis/developars-club