/forofyl.com.ar

ForoFyL's public website.

Primary LanguagePHP

ForoFyL

ForoFyL es un foro basado en phpBB y destinado a estudiantes de la Facultad de Filosofía y Letras de la Universidad de Buenos Aires (aunque tenemos unos cuantos agradables intrusos).

A través de este repositorio podés colaborar con el desarrollo del foro, ayundándonos a mejorarlo y a resolver eventuales bugs.

¿Cuáles son los requisitos básicos?

  1. Conocimiento de PHP y MySQL, y tenerlos instalados en tu máquina.
  2. Manejo de phpBB.
  3. Manejo de Git/Github y tener Git instalado en tu máquina.
  4. Un servidor web local como Apache o NGINX. Usamos NGINX en producción, por lo cual sería ideal que tengas instalado lo mismo, pero un Apache corriendo sobre XAMPP basta y sobra. De hecho, generalmente es la opción más fácil de instalar.

¿Cómo empezar?

  1. Cloná este repositorio a tu máquina.
  2. Importá la base de datos incluida en db/01-forofyl_phpbb.sql desde tu instalación de MySQL. Opcional: si querés tener un usuario específico para este proyecto, antes de importar la base de datos, ejecutá el script que está en db/00-pre_database_settings.sql, después db/01-forofyl_phpbb.sql, y por último db/02-post_database_settings.sql. La configuración de db/00-pre_database_settings.sql y de db/02-post_database_settings.sql podés modificarla a tu gusto.
  3. Copiá el archivo local-config-example.php y renombralo como local-config.php.
  4. Ajustá las variables del archivo local-config.php según la configuración de tu base de datos local.
  5. Accedé por medio de cualquier browser a la URL correspondiente a tu instalación local.
  6. Ingresá con permisos de administrador con el usuario dev y el password dev123.

Cosas a tener en cuenta

  • La ruta /phpbb/images/avatars/upload consiste en un link simbólico a la carpeta /shared/content/uploads/images/avatars/upload, la cual debe estar fuera del repositorio para facilitar el proceso de deployment. Nótese que /shared también es, a su vez, un link simbólico a ../shared/files, fuera del working tree del repositorio.
  • Las discusiones acerca de issues y la documentación que vaya surgiendo van a estar escritas en castellano, pero a la hora de documentar en el código, a fin de mantener la coherencia con el desarrollo original, vamos a escribir en inglés. Si se encuentra algo escrito en castellano correspondiente a código antiguo, debería ser traducido.
  • Algunos de los bugs que se vayan reconociendo pueden reportarse tanto acá como en el foro, pero a fin de mantener el trabajo sobre el código ordenado, lo estrictamente técnico se va a tratar acá, en la sección de issues.
  • El password de todos los usuarios existentes en la base de datos, excepto el usuario dev, es vivolejos.

¿Cómo enviar mi código?

Simplemente creá un fork de este proyecto, commiteá tu propio branch y hacé un pull request. Una vez hecho eso, revisamos tu código, y si está todo bien lo integramos y lo ponemos en producción.

Si no sabés programar y querés reportar un issue, eso también es más que bienvenido.