codu

Codú

Un espacio para codificadores

Codú es la mejor comunidad de desarrolladores web para aprender, compartir y obtener apoyo para sus proyectos, ya sea grande o pequeño. Es el lugar perfecto para afilar sus habilidades y construir su cartera. En Codú, todos estamos aquí para ayudarse mutuamente a crecer como desarrolladores web. Además, Codú hace que sea más fácil encontrar colaboradores para su próximo gran proyecto.

---

Únete a la conversación

Tenemos una comunidad fantástica que crece en discordia. ¡Haga clic aquí para unirse!

---

Instalación

1. Bifurca el proyecto
2. Clone con git clone https://github.com/YOUR_USERNAME/codu.git .
3. Navegue al cd codu del directorio del proyecto.
4. Instalar dependencias con:

npm install

• Si tiene algún problema para instalar dependencias, verifique su versión de nodo en contra de la .nvmrc . Si está utilizando nvm , puede ejecutar nvm use antes de instalar dependencias.

5. Cree un archivo .env y agregue las siguientes variables. Puede copiar el contenido de sample.env con cat sample.env > .env .

 # This default value is if you run our local docker-compose.yml file to create the database.
DATABASE_URL=postgresql://postgres:[email protected]:5432/postgres
# Setup your GitHub ID & Secret on GitHub: https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps
# For development, make sure you set up this with a Homepage URL of http://localhost:3000/ and an Authorization callback URL of http://localhost:3000/api/auth
GITHUB_ID=YOUR_GITHUB_APP_ID
GITHUB_SECRET=YOUR_GITHUB_APP_SECRET
NEXTAUTH_URL=http://localhost:3000/api/auth

Para una guía más detallada sobre cómo configurarlos, vaya a la sección Variables de entorno.

Nota: Antes de continuar, asegúrese de que su base de datos se esté ejecutando.

6. Configurar las tablas en la base de datos con llovizna ejecutando:

npm run db:migrate

El comando completo se puede ver en nuestro archivo paquete.json.

7. Sembra la base de datos con algunos datos simulados ejecutando:

npm run db:seed

El comando completo se puede ver en nuestro archivo paquete.json.

8. Finalmente, ejecute el servidor de desarrollo:

npm run dev

Después de completar los comandos anteriores, navegue a http: // localhost: 3000 en su navegador para ver el resultado.

Puede comenzar su viaje modificando pages/index.tsx . Con la función Auto-Update, las páginas actualizan mientras edita el archivo.

El directorio pages/api se asigna a /api/* . Los archivos en este directorio se tratan como rutas API en lugar de páginas reaccionadas.

Obtenga más información sobre las rutas API aquí.

Variables de entorno

Base de datos_url

DATABASE_URL es una cadena de conexión a una base de datos PostgreSQL (versión 15.0).

Por defecto, señalamos una base de datos que se ejecuta localmente con Docker de nuestro archivo docker-compose.yml .

Para ejecutar este archivo, asegúrese de tener Docker instalado y que Docker se esté ejecutando.

Ejecute el comando docker compose up .

Alternativamente, si tiene PostgreSQL ejecutándose localmente, puede usar su cadena de conexión local o tomar una de un servicio gratuito como Supabase.

Github_id y github_secret

Actualmente, solo permitimos la autenticación a través de GitHub. Para habilitar esto, debe tener un valor GITHUB_ID y GITHUB_SECRET .

Configure su ID y secreto de GitHub en GitHub:

• Haga clic aquí para configurar una nueva aplicación OAuth y complete los detalles como se muestra a continuación.

Para el desarrollo, asegúrese de configurar esto con una URL de la página de inicio de

 http://localhost:3000/

y una URL de devolución de llamada de autorización de

 http://localhost:3000/api/auth

Después de hacer clic en el botón "Registro de la aplicación", debería ver el GITHUB_ID y poder generar un nuevo secreto del cliente. Después de generar el secreto, asegúrese de copiar este valor a su archivo .env , ya que este valor no se puede volver a ver una vez que actualice la página.

Más información sobre la autorización de OAuth en la documentación de GitHub aquí.

Configuración de autores sin contraseña localmente

Para usar el inicio de sesión sin contraseña localmente, debe tener un valor ACCESS_KEY y SECRET_KEY .

Consulte el ejemplo .env archivo aquí para ver cómo completar estos valores.

Nota: Actualmente, la región de AWS del servicio SNS está codificada para "EU-West-1"; Puede ser necesario cambiar esto si su servicio SNS está en una región diferente.

NextAuth_url

No debería necesitar cambiar el valor predeterminado aquí. Esta es una variable utilizada por Next Auth como URL de autenticación en su sitio.

 NEXTAUTH_URL=http://localhost:3000/api/auth

Ejemplo .env archivo se puede encontrar aquí. Puede cambiar el nombre de esto a .env para comenzar.

? ‍ Directrices de contribución

• Las contribuciones son muy apreciadas . Las contribuciones hacen de la comunidad de código abierto un lugar increíble para aprender, inspirar y crear.
• Consulte nuestras pautas de contribución para contribuir a nuestro repositorio. Incluye
  • Cómo contribuir
  • Cómo crear una solicitud de extracción
  • Ejecutar pruebas
  • Guía de estilo para mensajes de confirmación

? Habilidades previas para contribuir

• Git

? Contribuciones de documentación

• Reducción

? Contribuciones de código

• Reaccionar
• Next.js
• Postgresql
• Viento de cola
• Llovizna

Recursos adicionales

Para obtener más información sobre Next.js, eche un vistazo a los siguientes recursos:

• Documentación Next.JS - Aprenda sobre las funciones de Next.js y la API.
• Aprende Next.js - Un tutorial interactivo Next.js.

Editor Doc

Para conocer los accesos directos y las teclas de acceso rápido del editor, puede consultar este documento:

• Markdoc Editor Hollkeys y atajos

? Prueba de E2E

Para obtener información sobre las pruebas E2E, consulte nuestra documentación dedicada aquí.

? Asuntos

Usted puede abrir temas para discutir ideas sobre la mejora de CODU. Se alientan y aprecian las mejoras.