Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 5.92 KB

INSTRUCTIONS.md

File metadata and controls

84 lines (50 loc) · 5.92 KB

Hackathon Image
Hackathon Supercívico

Instrucciones 📝

¡Bienvenidos al primer Hackathon Supercívico 🎉! Muchas felicidades por participar en uno de los eventos que impactarán de forma positiva a la comunidad en la que vivimos.

Sabemos que ya te urge programar esa gran idea que traes en la cabeza, y ¡gracias por tu entusiasmo! Pero antes, por favor lee con atención las siguientes indicaciones.

Antes de continuar, asegúrate que estás leyendo esto dentro del repositorio de tu equipo, y que la vertical seleccionada es la adecuada. En caso contrario por favor ponte en contacto de inmediato con cualquiera de los mentores a través del servidor de discord.

Plataforma

Esta edición del hackathon lo estaremos implementado directamente sobre GitHub y GitHub Classroom. Eso quiere decir que constantemente tendrás que estar subiendo tus cambios a la rama master de tu repo, que es la que se evaluará al final del evento.

Para eso les recomendamos seguir las buenas prácticas de git y GitHub, y con eso facilitar su trabajo en equipo. 😉

Toda la comunición se estará llevando a cabo a través del servidor de discord. 📥

Estructura del Entregable

Como saben, se espera de los participantes que entreguen un prototipo funcional al final del evento, pero también necesitamos ver su código para evaluar la complejidad del mismo. Es por eso que todo el código que involucre a su proyecto, deberá de estar en este repositorio. No se considerarán repositorios ajenos a éste.

Sugerencias de Estructura para el Proyecto 🧩

Cuando se trabajen con monorepos, o un sólo repositorio, para proyectos que involucren más de una pieza, es importante tener bien seperadas cada una de esas piezas para así evitar conflictos entre dependencias. Un ejemplo de cómo puedes lograr esto, es este proyecto que ganó otro hackathon hace poco 🌝.

Fíjate en que es un proyecto el cual tiene un cliente con React, y un backend con Node, pero a pesar de eso cada pieza tiene su carpeta para evitar conflictos entre ellos. 👌🏼

Si quieres saber más de los monorepos, da click aquí.

El Entregable Ideal 🌟

El entregable ideal es el que en la rama master tiene un README.md con las instrucciones de cómo probar su prototipo de manera local, con una breve documentación acerca de su proyecto (qué tecnologías usaron, que componontes tiene su proyecto, la estructura de la información, etc) y un enlace hacia el proyecto desplegado en alguna plataforma en donde podamos ver el proyecto trabajando de manera real.

Seguridad de los Recursos 🔑

Es muy probable que tengan que usar recursos externos dentro de sus proyectos, como APIs o bases de datos. Dichos recursos les serán muy útiles al momento de desarrollar sus proyectos, pero debes tener cuidado en cómo usas los tokens o accesos a dichos recursos, ya que recuerda que tu repo será público, y si alguien ve dichas llaves, podría hacer mal uso de ellas.

En lugar de hardcodear las llaves en tu código, considera usar variables de ambiente para así seguir aprovechando los recursos, pero sin comprometer la seguridad de los mismos. Si quieres saber más acerca de las variables de ambiente o entorno, haz clic aquí

Recursos gratuitos para estudiantes 🎁

Si eres estudiante, GitHub tiene un paquete en el cual incluye muchos beneficios, como créditos para servicios en la nube, dominios gratis por un año, almacenamiento gratis en la nube y mucho más! Si quieres acceder a dichos beneficios, haz clic aquí

FAQ 👈🏼

¿Qué es el hackathon Supercivico? El Hackathon Supercivico busca que entre todos resolvamos problemas de todos los días haciendo uso de la tecnología.

¿En qué horarios se llevará a cabo el evento? El Hackathon inicia el viernes 28 de agosto a las 5:00 pm de la Ciudad de México y termina el sábado 30 de agosto a las 8:00 pm de la ciudad de México. Vamos a trabajar un poco más de 48 horas continuas.

¿Cuál es la cantidad máxima de integrantes por equipo? Los equipos deben de ser de 5 personas máximo

¿Qué se debe de entregar al final? Los participantes deberán mostrar un prototipo funcional

Me gustaría recibir ayuda de uno de los mentores, ¿a quién le puedo decir? Si necesitas una mentoría puedes solicitarla en los canales pertinentes dentro del servidor de discord. Hay mentores de varias disciplinas, apróvechalos para que tu proyecto esté súper completo.

¿Qué tecnologías puedo usar? Puedes desarrollar en cualquier tecnología, tu única preocupación debe de ser que funcione.

Tengo una pregunta que no se responde aquí ¿Qué hago? Puedes enviarnos un mensaje a #evento-ayuda dentro del servidor de discord o al correo hola@hackathones.mx

Código de conducta 💞

Usamos el código de conducta de MLH que puedes leer aquí. Bajo el código de conducto no se permite hacer comentarios sexistas, racistas o clasistas. Si hay alguna situación que te haga sentir de manera incómoda no dudes en escribirnos a hola@hackathones.mx.

Licencia

El proyecto se rige por una licencia del MIT. Después del evento la podrás cambiar sin problema. El código desarrollado y el producto final es de los integrantes del equipo y ninguna de las organizaciones tendrá alguna atribución.

Mucho Éxito! Recuerda dar lo mejor de ti, pero sobre todo divertirte 🚀