Open Library un catálogo de biblioteca abierto y editable, que se construye con el objetivo de crear una página web para todo libro que ha sido publicado
¿Estás buscando comenzar? Esta es la guía que estas buscando. Tal vez te gustaría saber más del programa Google Summer of Code (GSoC)? o del Hacktoberfest.
- Descripción
- Instalación
- Organización del Código
- Arquitectura
- Guía de Desarrollador
- Ejecución de Pruebas
- Cómo Contribuir
- APIs Públicas
- Preguntas Frecuentes
Open Library es un esfuerzo empezado en el 2006 para crear "una página web para todo libro que ha sido publicado." Esta provee acceso a múltiples libros de dominio público y descatalogados que pueden leerse en línea.
Aquí tienes un recorrido público y rápido de Open Library para que te puedas familiarizar con el servicio y lo que ofrece (10min).
Ejecuta docker compose up y visita http://localhost:8080
¿Necesitas más detalles? Checa las Instrucciones de Docker o el video tutorial.
Alternativamente, Si no quieres montar Open Library en tu computadora local, prueba Gitpod!
Esto te deja trabajar en Open Library enteramente desde tu navegador sin tener que instalar nada en tu computadora personal.
Advertencia: Esta integración sigue siendo experimental.
También puedes encontrar más información sobre la Documentación para Desarrolladores de Open Library en la Wiki de Open Library.
- openlibrary/core - funcionalidad central de Open Library, importada y utilizada por www
- openlibrary/plugins - otros modelos, controladores y ayudantes de vista (view helpers)
- openlibrary/views - vistas para renderizar páginas web
- openlibrary/templates - todas las plantillas utilizadas en el sitio web
- openlibrary/macros - los macros son similares a las plantillas, pero pueden ser llamados desde wikitext
Open Library es desarrollado sobre el sistema wiki Infogami, que a su vez está construido sobre el framework web.py de Python y el framework de base de datos Infobase.
Una vez que hayas leído la descripción general de las tecnologías Backend de OpenLibrary, es sumamente recomendable que le des una leída a la guía básica para desarrolladores, la cual explica como usar Infogami (y su base de datos, Infobase).
Si quieres profundizar en el código fuente de Infogami, consulta el repo de Infogami.
Las pruebas de Open Library puedes ser ejecutadas usando docker. Consulta nuestro Documento de Pruebas para más detalles.
docker compose run --rm home make test
Hay muchas formas en las cuales voluntarios pueden contribuir al proyecto Open Library, desde el desarrollo y diseño hasta la gestión de datos y la participación de la comunidad. De estas formas puedes involucrarte:
- Empezando: Checa nuestra Guía de Contribuciones para tener instrucciones de como configurar tu entorno de desarrollo, encuentra issues en los cuales trabajar, y envia tus contribuciones.
- Buen Primer Issue (Good First Issues): Explora nuestros Good First Issues para encontrar tareas sencillas para principiantes.
- Contribuciones de Diseño: Son bienvenidos los diseñadores que deseen ayudar a mejorar la experiencia del usuario. Pueden comenzar revisando issues relacionados con diseño.
- Contribuciones de Datos: Aprende como contribuir a nuestro catálogo y ayudar a mejorar la información sobre libros en Open Library. Visita nuestra página de voluntarios para más información.
- Únete a nuestras Llamadas Comunitarias: Open Library organiza llamadas semanales de comunidad y diseño. Checa el Planograma de llamadas comunitarias para tiempos y detalles.
- Pregunta: Si tienes cualquier duda, únete a nuestro chat de gitter o pide una invitación a nuestro canal de Slack en nuestra página de voluntarios.
Para información más detallada, consulta la Guía de Contribuciones.
Todo el código fuente publicado aqui esta disponible bajo los términos de la licencia GNU Affero General Public License, version 3.