briefkasten

? Brouillard

Briefkasten (en: boîte aux lettres) - Am Haus- oder wohnungseingang angebrachter behälter für die dem empfänger zugestellten [post] Sentungen

Application de marque d'auto-hébergement. Fonctionne avec n'importe quelle base de données compatible PRISMA (MySQL, Postgres, Sqlite, etc.)

Avertissement

Briefkasten V2 est actuellement disponible en bêta à https://dev.briefkastenhq.com

Après la période bêta, la base de données sera supprimée , afin que nous puissions migrer toutes les données existantes de la (V1) briefkastenhq.com actuelle vers la nouvelle version. Je travaille déjà sur les nouveaux documents, mais les documents V1 sont bien sûr toujours disponibles. Si vous trouvez des bogues ou si vous souhaitez aider, vous pouvez contribuer à ndom91/sveltekasten ou ndom91/briefkasten-docs .

Instance gratuite: Briefkastenhq.com [DOCS]

? Captures d'écran

? Caractéristiques

• Enregistrer par extension du navigateur
• Extraction automatique du titre et de la description
• URL de glisser-déposer sur la page pour enregistrer
• Raccourcis clavier
• Organiser par catégories et balises
• Importer et exporter des signets à partir du format HTML standard
• Bookmark Image Rechening Background Job
• Vues multiples
• Recherche de texte complet
• API REST
• OAuth + Email Magic Link Connexion

? Condition préalable

Pour s'auto-héberger cette application, vous aurez besoin des Thins suivants:

1. Plate-forme de serveur / d'hébergement pour une application Next.js (c'est-à-dire Vercel / Netlify)
2. Pour OAuth Login, un compte de développeur dans l'un des fournisseurs soutenus par NextAuth.js
3. Base de données qui fonctionne avec Prisma (c'est-à-dire MySQL, Postgres, Sqlite, etc.)
4. Espace d'hébergement d'image (c'est-à-dire Supabase / ImageKit / Cloudinary) ( facultatif )

Ce sont tous relativement simples, à part l'image Hoster. Cela a été choisi pour éviter de mettre les images dans la base de données. L'exemple d'application sur BriefkastenhQ.com utilise le stockage Supabase, mais tout autre fournisseur similaire comme Cloudinary ou un simple seau S3 ferait également le travail. J'ai choisi Supabase, car ils ont un SDK facile à utiliser, un niveau gratuit décent, et j'utilisais déjà leur service Postgres.

Une fois que vous avez une configuration de compte dans tous les fournisseurs ci-dessus, ou que votre propre infrastructure soit prête à l'emploi, vous pouvez continuer aux prochaines étapes ci-dessous.

Commencer

1. Cloner le référentiel

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

2. Installer des dépendances

$ pnpm install

3. Copiez le fichier .env.example sur .env et ouvrez-le avec votre éditeur de texte préféré pour remplir vos variables d'environnement.

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

Dans ce fichier de variables d'environnement, assurez-vous de remplir au moins la DATABASE_URL , NEXTAUTH_URL et NEXTAUTH_SECRET . Le reste des variables d'environnement dépend des services / fonctionnalités que vous souhaitez utiliser. Par exemple, Google / GitHub pour la connexion OAuth et / ou Supabase pour le stockage d'objets.

4. Démarrez le serveur!

// First time only
$ pnpm db:push

// dev
$ pnpm dev

// prod
$ pnpm build
$ pnpm start

? Docker

Vous pouvez également vous auto-hoster Briefkasten avec Docker. Pour ce faire, vous devez:

1. Installez docker et docker-compose .
2. Clone le référentiel et copiez le fichier .env.example dans .env .
   1. Ici, vous devez également remplir les variables d'environnement DATABASE_URL et NEXTAUTH_* au minimum.
   2. La DATABASE_URL pour le conteneur postgres doit être DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable
3. Exécutez docker-compose up -d dans la racine du référentiel. Cela démarrera l'application ainsi que la base de données pour vous.
4. Après le début initial, vous devez toujours semer manuellement la base de données. Cela se fait le plus facilement via le conteneur de l'application ( bk-app ).
   1. Exécutez docker exec -it bk-app /bin/bash pour entrer une session de terminal à l'intérieur du conteneur.
   2. Ensuite, exécutez pnpm db:push à l'intérieur du conteneur. Cela poussera le schéma de la base de données de PRISMA à la base de données configurée.
5. Maintenant, votre application et votre base de données doivent être opérationnelles à la par défaut http://localhost:3000

Plus de détails peuvent être trouvés dans la section Docker des documents.

? En rapport

? Enregistrer à partir du menu Android Share

Avec cet application open source raccourcis http, vous pouvez créer un élément de "menu de partage" qui exécute une demande POST avec une entrée dynamique, c'est-à-dire une URL et un titre d'une page Web. Cela facilite le partage des articles de votre téléphone à Briefkasten! Plus d'informations dans les documents.

? Extension du navigateur

Il y a une extension de navigateur compagnon dans les travaux que vous pouvez utiliser pour ajouter des sites Web à votre coffre-fort tout en parcourant le Web. Il peut être trouvé au ndom91/briefkasten-extension et dans le Chrome Extension Store. Plus de détails dans ce référentiel.

? ‍? Capture d'écran

Il existe également un travail de fond pour remplir des signets qui n'ont pas d'image valide. Il peut être trouvé dans le référentiel ndom91/briefkasten-scrape . Ce travail fonctionne toutes les 2 heures dans une action GitHub et traite 10 signets à la fois.

? Contributif

Ce projet est ouvert à toutes les contributions! Veuillez vous en tenir aux paramètres Eslint / plus jolis et je serai heureux de jeter un œil à votre problème / PR?

Licence

Mit