openlibrary

Offene Bibliothek

Open Library ist ein offener, bearbeitbarer Bibliothekskatalog, der für jedes jemals veröffentlichte Buch auf eine Webseite erstellt wird.

Möchten Sie anfangen? Dies ist der Leitfaden, den Sie suchen. Möglicherweise möchten Sie mehr über Google Summer of Code (GSOC) erfahren? oder Hacktoberfest.

Inhaltsverzeichnis

• Überblick

• Installation

• Codeorganisation

• Architektur

• Der Frontend

• Das Backend

• Die Servicearchitektur

• Entwicklerleitfaden

• Auslauftests

• Beitragen

• Öffentliche APIs

• FAQs

Überblick

Open Library ist ein Aufwand im Jahr 2006, um "eine Webseite für jedes jemals veröffentlichte Buch" zu erstellen. Es bietet Zugang zu vielen öffentlich-domänen- und außerfeiligen Büchern, die online gelesen werden können.

Hier ist eine kurze öffentliche Tour durch die offene Bibliothek, um Sie mit dem Service und seinen Angeboten (10 Minuten) vertraut zu machen.

• Erfahren Sie mehr über das Open Library -Projekt

• Die Vision (Traum) von OpenLibrary

• Besuchen Sie den Blog

Installation

Run docker compose up und besuchen Sie http: // localhost: 8080

Benötigen Sie weitere Details? Checkout der Docker -Anweisungen oder der Video -Tutorial.

Wenn Sie nicht auf Ihrem lokalen Computer eine offene Bibliothek einrichten möchten, versuchen Sie es mit GitPod! Auf diese Weise können Sie vollständig in Ihrem Browser an der offenen Bibliothek arbeiten, ohne etwas auf Ihrem PC installieren zu müssen. Warnung: Diese Integration ist immer noch experimentell.

Entwicklerleitfaden

Anweisungen zur Verwaltung Ihrer Open Library -Instanz finden Sie im QuickStart -Handbuch des Entwicklers.

Weitere Informationen zu Entwicklerdokumentationen für die offene Bibliothek finden Sie im Open Library Wiki.

Codeorganisation

• OpenLibrary/Core - Core OpenLibrary -Funktionalität, importiert und von www verwendet

• OpenLibrary/Plugins - andere Modelle, Controller und Ansichtshelfer

• OpenLibrary/Ansichten - Ansichten zum Rendern von Webseiten

• OpenLibrary/Vorlagen - Alle auf der Website verwendeten Vorlagen

• OpenLibrary/Makros - Makros sind wie Vorlagen, können aber aus Wikitext aufgerufen werden

Architektur

Das Backend

OpenLibrary wird oben im Infogami -Wiki -System entwickelt, das selbst auf dem Web.Py Python Web Framework und im Infobase Database Framework aufgebaut ist.

• Überblick über Backend -Web -Technologien

Sobald Sie den Überblick über OpenLibrary -Backend -Technologien gelesen haben, wird Sie sehr ermutigt, den Entwickler -Primer zu lesen, der erklärt, wie Infogami (und seine Datenbank, Infobase) verwendet werden.

• Infogami -Entwickler -Tutorial

Wenn Sie in den Quellcode für Infogami eintauchen möchten, lesen Sie das Infogami -Repo.

Auslauftests

Offene Bibliothekstests können mit Docker durchgeführt werden. Weitere Informationen finden Sie in unserem Testdokument, um weitere Details zu erhalten.

docker compose run --rm home make test

Beitragen

Es gibt viele Möglichkeiten, wie Freiwillige zum Open Library -Projekt beitragen können, von Entwicklung und Design bis hin zum Datenmanagement und dem Engagement der Gemeinschaft. So können Sie sich engagieren:

Entwickler

• Erste Schritte: Weitere Informationen zum Einrichten Ihrer Entwicklungsumgebung finden Sie in unserem beitragenden Leitfaden, finden Sie Probleme, an denen Sie arbeiten und Ihre Beiträge einreichen können.

• Gute erste Ausgaben: Durchsuchen Sie unsere guten ersten Ausgaben, um anfängerfreundliche Aufgaben zu finden.

Designer

• Designbeiträge: Wir begrüßen Designer, um die Benutzererfahrung zu verbessern. Sie können sich zunächst mit Designproblemen befassen.

Bibliothekare und Datenbegeisterte

• Datenbeiträge: Erfahren Sie, wie Sie zu unserem Katalog beitragen und die Buchdaten in der offenen Bibliothek verbessern können. Besuchen Sie unsere Freiwilligenseite für weitere Informationen.

Engagement der Gemeinschaft

• Treten Sie unseren Community -Anrufen bei: Open Library Hosts wöchentliche Community- und Design -Anrufe. Überprüfen Sie den Community -Anrufplan für Zeiten und Details.

• Stellen Sie Fragen: Wenn Sie Fragen haben, nehmen Sie an unserem Gitter -Chat bei oder fordern Sie eine Einladung zu unserem Slack -Kanal auf unserer Freiwilligenseite an.

Ausführlichere Informationen finden Sie im beitragenden Leitfaden.

Lizenz

Alle hier veröffentlichten Quellcode sind unter den Bestimmungen der GNU Affero General Public Lizenz, Version 3, verfügbar.