briefkasten

? Briefkasten

Briefkasten (EN: Kotak Surat) - AM Haus -oder Wohnungseingang Anggebrachter Behälter für die Dem Empfänger Zugestellten [POST] Sendungen

Aplikasi bookmark yang diselenggarakan sendiri. Bekerja dengan basis data yang kompatibel Prisma (MySQL, Postgres, SQLite, dll.)

Peringatan

Briefkasten V2 saat ini tersedia di beta di https://dev.briefkastenhq.com

Setelah periode beta, database akan dijatuhkan , sehingga kami dapat memigrasikan semua data yang ada dari briefkastenhq.com saat ini (V1) ke versi baru. Saya sudah mengerjakan dokumen baru, tetapi dokumen V1 tentu saja masih tersedia. Jika Anda menemukan bug, atau ingin membantu, Anda dapat berkontribusi di ndom91/sveltekasten atau ndom91/briefkasten-docs .

Contoh Gratis: briefkastenhq.com [Dokumen]

? Tangkapan layar

? Fitur

• Simpan dengan ekstensi browser
• Judul dan deskripsi otomatis ekstraksi
• URL drag-and-drop di halaman untuk menyimpan
• Pintasan keyboard
• Atur berdasarkan kategori dan tag
• Impor dan Ekspor Bookmark dari Format HTML Standar
• Bookmark gambar mengambil pekerjaan latar belakang
• Beberapa tampilan
• Pencarian FullText
• API istirahat
• OAuth + Email Magic Link Login

? Prasyarat

Untuk menjadi tuan rumah mandiri aplikasi ini, Anda akan membutuhkan penipisan berikut:

1. Platform Server / Hosting untuk Aplikasi Next.js (yaitu Vercel / Netlify)
2. Untuk OAuth Login, akun pengembang di salah satu penyedia yang didukung oleh NextAuth.js
3. Database yang bekerja dengan prisma (yaitu mysql, postgres, sqlite, dll.)
4. Ruang Hosting Gambar (yaitu Supabase / ImageKit / Cloudinary) ( Opsional )

Ini semua relatif lurus ke depan, selain gambar hoster. Ini dipilih untuk menghindari menempatkan gambar di database. Contoh aplikasi di briefkastenhq.com menggunakan penyimpanan Supabase, tetapi penyedia serupa lainnya seperti ember S3 Cloudinary atau sederhana juga akan melakukan pekerjaan itu. Saya memilih Supabase, karena mereka memiliki SDK yang mudah digunakan, tingkat bebas yang layak, dan saya sudah menggunakan layanan postgres mereka.

Setelah Anda memiliki pengaturan akun di semua penyedia di atas, atau menyiapkan infrastruktur Anda sendiri, Anda dapat melanjutkan ke langkah -langkah berikutnya di bawah ini.

Memulai

1. Klon Repositori

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

2. Instal dependensi

$ pnpm install

3. Salin file .env.example ke .env , dan buka dengan editor teks favorit Anda untuk mengisi variabel lingkungan Anda.

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

Dalam file variabel lingkungan ini, pastikan untuk setidaknya mengisi DATABASE_URL , NEXTAUTH_URL dan NEXTAUTH_SECRET . Variabel lingkungan lainnya bergantung pada layanan / fitur yang ingin Anda gunakan. Misalnya, Google/GitHub untuk login OAuth dan/atau Supabase untuk penyimpanan objek.

4. Mulai server!

// First time only
$ pnpm db:push

// dev
$ pnpm dev

// prod
$ pnpm build
$ pnpm start

? Buruh pelabuhan

Anda juga dapat menjadi tuan rumah swadaya briefkasten dengan Docker. Untuk melakukannya, Anda harus:

1. Pasang docker dan docker-compose .
2. Kloning repositori dan salin .env.example ke file .env .
   1. Di sini Anda juga perlu mengisi variabel lingkungan DATABASE_URL dan NEXTAUTH_* setidaknya.
   2. DATABASE_URL untuk wadah postgres harus DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable
3. Jalankan docker-compose up -d di akar repositori. Ini akan memulai aplikasi serta database untuk Anda.
4. Setelah awal awal, Anda masih harus menemui database secara manual. Ini paling mudah dilakukan melalui wadah aplikasi ( bk-app ).
   1. Jalankan docker exec -it bk-app /bin/bash untuk memasukkan sesi terminal di dalam wadah.
   2. Kemudian jalankan pnpm db:push di dalam wadah. Ini akan mendorong skema basis data dari prisma ke database yang dikonfigurasi.
5. Sekarang aplikasi dan basis data Anda harus berjalan dan berjalan di http://localhost:3000

Rincian lebih lanjut dapat ditemukan di bagian Docker dari dokumen tersebut.

? Terkait

? Simpan dari menu berbagi android

Dengan aplikasi HTTP aplikasi open-source ini, Anda dapat membuat item "Bagikan Menu" yang mengeksekusi permintaan POST dengan input dinamis, yaitu URL dan judul halaman web. Ini membuatnya sangat mudah untuk berbagi item dari ponsel Anda ke briefkasten! Informasi lebih lanjut dalam dokumen.

? Ekstensi Browser

Ada ekstensi browser pendamping dalam karya yang dapat Anda gunakan untuk menambahkan situs web ke lemari besi Anda saat menjelajahi web. Ini dapat ditemukan di ndom91/briefkasten-extension dan di Chrome Extension Store. Rincian lebih lanjut dalam repositori itu.

? ‍? Pekerjaan tangkapan layar

Ada juga pekerjaan latar belakang untuk mengisi bookmark yang tidak memiliki gambar yang valid. Ini dapat ditemukan di repositori ndom91/briefkasten-scrape . Pekerjaan ini berjalan setiap 2 jam dalam aksi GitHub dan memproses 10 bookmark sekaligus.

? Berkontribusi

Proyek ini terbuka untuk setiap dan semua kontribusi! Harap tetap pada pengaturan Eslint / yang lebih cantik dan saya akan dengan senang hati melihat masalah / PR Anda?

Lisensi

Mit