openlibrary

Bibliothèque ouverte

La bibliothèque ouverte est un catalogue de bibliothèque open et modifiable, qui se dirige vers une page Web pour chaque livre jamais publié.

Cherchez-vous à commencer? Ceci est le guide que vous recherchez. Vous souhaiterez peut-être en savoir plus sur Google Summer of Code (GSOC)? ou hacktoberfest.

Table des matières

• Aperçu

• Installation

• Organisation de code

• Architecture

• Le frontend

• Le backend

• L'architecture de service

• Guide du développeur

• Tests en cours d'exécution

• Contributif

• API publiques

• FAQ

Aperçu

Open Library est un effort démarré en 2006 pour créer "une page Web pour chaque livre jamais publié". Il donne accès à de nombreux livres de domaine public et hors imprimé, qui peuvent être lus en ligne.

Voici une visite publique rapide de la bibliothèque ouverte pour vous familiariser avec le service et ses offres (10 minutes).

• En savoir plus sur le projet Open Library

• La vision (rêve) de l'OpenLibrary

• Visitez le blog

Installation

Exécutez docker compose up et visitez http: // localhost: 8080

Besoin de plus de détails? Découvrez les instructions Docker ou le tutoriel vidéo.

Alternativement , si vous ne souhaitez pas configurer une bibliothèque ouverte sur votre ordinateur local, essayez Gitpod! Cela vous permet de travailler entièrement sur une bibliothèque ouverte dans votre navigateur sans avoir à installer quoi que ce soit sur votre ordinateur personnel. Avertissement: cette intégration est toujours expérimentale.

Guide du développeur

Pour des instructions sur l'administration de votre instance de bibliothèque ouverte, reportez-vous au guide QuickStart du développeur.

Vous pouvez également trouver plus d'informations concernant la documentation des développeurs pour la bibliothèque ouverte dans le wiki de la bibliothèque ouverte.

Organisation de code

• Fonctionnalité OpenLibrary / Core - Core OpenLibrary, importée et utilisée par www

• OpenLibrary / Plugins - Autres modèles, contrôleurs et assistants

• OpenLibrary / Views - Vues pour le rendu des pages Web

• OpenLibrary / Modèles - Tous les modèles utilisés dans le site Web

• OpenLibrary / Macros - Les macros sont comme des modèles, mais peuvent être appelés à partir de wikitext

Architecture

Le backend

OpenLibrary est développé au-dessus du système Wiki Infogami, qui est lui-même construit sur le cadre Web Web.py Python et le cadre de la base de données Infobase.

• Aperçu des technologies Web backend

Une fois que vous avez lu l'aperçu des technologies backend OpenLibrary, il est fortement encouragé à lire l'amorce du développeur qui explique comment utiliser Infogami (et sa base de données, Infobase).

• Tutoriel de développeur infogami

Si vous souhaitez plonger dans le code source de Infogami, consultez le repo infogami.

Tests en cours d'exécution

Les tests de bibliothèque ouverts peuvent être exécutés à l'aide de Docker. Veuillez consulter notre document de test pour plus de détails.

docker compose run --rm home make test

Contributif

Il existe de nombreuses façons dont les bénévoles peuvent contribuer au projet Open Library, du développement et de la conception à la gestion des données et à l'engagement communautaire. Voici comment vous pouvez vous impliquer:

Développeurs

• Démarrage: consultez notre guide de contribution pour des instructions sur la façon de configurer votre environnement de développement, de trouver des problèmes sur lesquels travailler et de soumettre vos contributions.

• Bon premier problème: parcourez nos bons premiers problèmes pour trouver des tâches adaptées aux débutants.

Designers

• Contributions de conception: Nous accueillons les concepteurs pour aider à améliorer l'expérience utilisateur. Vous pouvez commencer par regarder les problèmes liés au design.

Bibliothécaires et amateurs de données

• Contributions de données: Apprenez à contribuer à notre catalogue et à améliorer les données du livre sur la bibliothèque ouverte. Visitez notre page de bénévolat pour plus d'informations.

Engagement communautaire

• Rejoignez nos appels communautaires: Open Library organise des appels de communauté et de conception hebdomadaires. Consultez le calendrier des appels communautaires pour les temps et les détails.

• Posez des questions: si vous avez des questions, rejoignez notre chat gitter ou demandez une invitation à notre chaîne Slack sur notre page Volunteers.

Pour des informations plus détaillées, reportez-vous au guide de contribution.

Licence

Tous les code source publiés ici sont disponibles en vertu des termes de la licence GNU Affero General Public, version 3.