briefkasten

? Briefkasten

Briefkasten (en: Mailbox) - Am Haus- oder WohnungSingang Angebachter Behälter für die dem empfängger zugestellten [post] sendungen

Selbst gehostete Lesezeichenanwendung. Arbeitet mit jeder Prisma -kompatiblen Datenbank (MySQL, Postgres, SQLite usw.)

Warnung

Briefkasten V2 ist derzeit in Beta unter https://dev.briefkastenhq.com erhältlich

Nach der Beta -Zeit wird die Datenbank fallen gelassen , sodass wir alle vorhandenen Daten aus dem aktuellen (v1) briefkastenhq.com auf die neue Version migrieren können. Ich arbeite bereits an den neuen Dokumenten, aber die V1 -Dokumente sind natürlich noch verfügbar. Wenn Sie Fehler finden oder auf andere Weise helfen möchten, können Sie bei ndom91/sveltekasten oder ndom91/briefkasten-docs beitragen.

Kostenlose Instanz: Briefkastenhq.com [DOCS]

? Screenshots

? Merkmale

• Speichern durch Browsererweiterung
• Automatische Titel- und Beschreibungsextraktion
• Drag-and-Drop-URLs auf der Seite zum Speichern
• Tastaturverknüpfungen
• Organisieren nach Kategorien und Tags
• Importieren und exportieren Sie Lesezeichen aus dem Standard -HTML -Format
• Lesezeichen im Bild des Hintergrunds für den Hintergrund
• Mehrere Ansichten
• FullText -Suche
• Ruhe -API
• OAuth + E -Mail Magic Link Anmeldung

? Voraussetzungen

Um diese Anwendung selbst zu veranstalten, benötigen Sie die folgenden Thins:

1. Server- / Hosting -Plattform für eine Next.js -Anwendung (dh Vercel / netlify)
2. Für OAuth Login, ein Entwicklerkonto bei jedem der von Nextauth.js unterstützten Anbieter
3. Datenbank, die mit Prisma funktioniert (dh Mysql, Postgres, SQLite usw.)
4. Image Hosting Space (dh Supabase / ImageKit / Cloudinary) ( optional )

Diese sind alle relativ einfach, abgesehen von dem Image Tafel. Dies wurde ausgewählt, um zu vermeiden, dass die Bilder in die Datenbank gesteckt werden. Die Beispielanwendung bei Briefkastenhq.com verwendet Supabase -Speicher, aber jeder andere ähnliche Anbieter wie Cloudinary oder einen einfachen S3 -Bucket würde den Job ebenfalls erledigen. Ich habe Supabase gewählt, weil sie eine einfach zu verwendende SDK, eine anständige freie Stufe haben, und ich habe bereits ihren Postgres -Service verwendet.

Nachdem Sie bei allen oben genannten Anbietern ein Konto eingerichtet haben oder Ihre eigene Infrastruktur bereit sind, können Sie die nächsten Schritte unten fortsetzen.

Erste Schritte

1. Klonen Sie das Repository

$ git clone [email protected]:ndom91/briefkasten.git && cd briefkasten

2. Abhängigkeiten installieren

$ pnpm install

3. Kopieren Sie die Datei .env.example in .env und öffnen Sie sie mit Ihrem bevorzugten Texteditor, um Ihre Umgebungsvariablen auszufüllen.

$ cp .env.example .env
$ vim .env

Stellen Sie in dieser Umgebungsvariablen -Datei sicher, dass Sie mindestens die DATABASE_URL , NEXTAUTH_URL und NEXTAUTH_SECRET ausfüllen. Der Rest der Umgebungsvariablen hängt von den Diensten / Funktionen ab, die Sie verwenden möchten. Zum Beispiel Google/Github für OAuth Login und/oder Supabase für Objektspeicher.

4. Starten Sie den Server!

// First time only
$ pnpm db:push

// dev
$ pnpm dev

// prod
$ pnpm build
$ pnpm start

? Docker

Sie können Shortkasten auch mit Docker selbst veranstalten. Um dies zu tun, müssen Sie:

1. Installieren Sie docker und docker-compose .
2. Klonen Sie das Repository und kopieren Sie die .env.example in .env -Datei.
   1. Hier müssen Sie auch die Umgebungsvariablen DATABASE_URL und NEXTAUTH_* mindestens ausfüllen.
   2. Die DATABASE_URL für den Postgres -Container sollte DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable
3. Führen Sie docker-compose up -d im Stammwurzel des Repositorys aus. Dadurch wird sowohl die Anwendung als auch die Datenbank für Sie gestartet.
4. Nach dem ersten Start müssen Sie die Datenbank noch manuell säen. Dies ist am einfachsten über den App-Container ( bk-app ).
   1. Führen Sie docker exec -it bk-app /bin/bash aus, um eine Terminalsitzung im Container einzugeben.
   2. Führen Sie dann pnpm db:push . Dadurch wird das Datenbankschema von Prisma in die konfigurierte Datenbank übertragen.
5. Jetzt sollte Ihre Anwendung und Datenbank im Standard http://localhost:3000 ausgeführt werden

Weitere Details finden Sie im Abschnitt Docker der Dokumente.

? Verwandt

? Speichern im Menü Android Share

Mit dieser Open-Source-Anwendung HTTP-Verknüpfungen können Sie ein "Menü" -Menü "erstellen, das eine POST mit dynamischen Eingaben ausführt, dh die URL und den Titel einer Webseite. Dies macht es super einfach, Artikel von Ihrem Telefon an Briefkasten zu teilen! Weitere Informationen in den Dokumenten.

? Browsererweiterung

Es gibt eine Begleitbrowser -Erweiterung in den Arbeiten, mit der Sie Ihrem Gewölbe Websites hinzufügen können, während Sie das Web durchsuchen. Es kann in ndom91/briefkasten-extension und im Chrome-Erweiterungsgeschäft gefunden werden. Weitere Details in diesem Repository.

? ‍? Screenshot Job

Es gibt auch einen Hintergrundjob, um Lesezeichen auszufüllen, die kein gültiges Bild haben. Es kann im ndom91/briefkasten-scrape Repository gefunden werden. Dieser Job läuft alle 2 Stunden in einer Github -Aktion und verarbeitet 10 Lesezeichen gleichzeitig.

? Beitragen

Dieses Projekt steht allen Beiträgen offen! Bitte halten Sie sich bei den Einstellungen von Eslint / schöneren und ich werde gerne Ihr Problem / Ihre PR ansehen?

Lizenz

MIT