briefkasten

- buthkasten

BURTCKASTEN (en: กล่องจดหมาย) - Am Haus- oder wohnungseingang Angebrachter Behälterfür die dem empfänger zugestellten [โพสต์] Sendungen

แอปพลิเคชั่นบุ๊กมาร์กที่โฮสต์ตนเอง ทำงานร่วมกับฐานข้อมูลที่เข้ากันได้ของ PRISMA (MySQL, Postgres, SQLite ฯลฯ )

คำเตือน

BURFISKASTEN V2 มีวางจำหน่ายแล้วที่เบต้าที่ https://dev.briefkastenhq.com

หลังจากระยะเวลาเบต้า ฐานข้อมูลจะลดลง เพื่อให้เราสามารถโยกย้ายข้อมูลที่มีอยู่ทั้งหมดจาก briefkastenhq.com ปัจจุบัน (v1) ไปยังเวอร์ชันใหม่ ฉันกำลังทำงานกับเอกสารใหม่อยู่แล้ว แต่เอกสาร V1 ยังคงมีอยู่แน่นอน หากคุณพบข้อบกพร่องใด ๆ หรือต้องการความช่วยเหลือคุณสามารถมีส่วนร่วมได้ที่ ndom91/sveltekasten หรือ ndom91/briefkasten-docs

อินสแตนซ์ฟรี: brighkastenhq.com [เอกสาร]

- ภาพหน้าจอ

- คุณสมบัติ

• บันทึกโดยส่วนขยายเบราว์เซอร์
• การสกัดชื่อและคำอธิบายอัตโนมัติ
• URL แบบลากแล้ววางบนหน้าเพื่อบันทึก
• แป้นพิมพ์ลัด
• จัดระเบียบตามหมวดหมู่และแท็ก
• นำเข้าและส่งออกบุ๊กมาร์กจากรูปแบบ HTML มาตรฐาน
• บุ๊กมาร์กภาพการดึงงานพื้นหลัง
• หลายมุมมอง
• การค้นหา FullText
• REST API
• OAUTH + EMAIL MAGIC LINK เข้าสู่ระบบ

- ข้อกำหนดเบื้องต้น

ในการโฮสต์แอปพลิเคชันนี้คุณจะต้องมีสิ่งเหล่านี้:

1. แพลตฟอร์มเซิร์ฟเวอร์ / โฮสติ้งสำหรับแอปพลิเคชัน next.js (เช่น vercel / netlify)
2. สำหรับการเข้าสู่ระบบ OAuth บัญชีนักพัฒนาที่ผู้ให้บริการรายใดรายหนึ่งที่สนับสนุนโดย nextauth.js
3. ฐานข้อมูลที่ทำงานกับ Prisma (เช่น MySQL, Postgres, SQLite ฯลฯ )
4. อิมเมจโฮสติ้งพื้นที่ (เช่น supabase / imagekit / Cloudinary) ( ไม่บังคับ )

ทั้งหมดนี้ค่อนข้างตรงไปตรงมานอกเหนือจากภาพฮอสเตอร์ สิ่งนี้ถูกเลือกเพื่อหลีกเลี่ยงการวางภาพในฐานข้อมูล แอปพลิเคชั่นตัวอย่างที่ brighkastenhq.com ใช้ที่เก็บข้อมูล supabase แต่ผู้ให้บริการอื่น ๆ ที่คล้ายกันเช่น Cloudinary หรือถัง S3 ที่เรียบง่ายก็จะทำงานได้เช่นกัน ฉันเลือก Supabase เพราะพวกเขามี SDK ที่ใช้งานง่ายระดับฟรีที่เหมาะสมและฉันก็ใช้บริการ Postgres ของพวกเขาอยู่แล้ว

หลังจากที่คุณมีการตั้งค่าบัญชีที่ผู้ให้บริการข้างต้นทั้งหมดหรือเตรียมโครงสร้างพื้นฐานของคุณเองให้พร้อมคุณสามารถดำเนินการต่อไปยังขั้นตอนถัดไปด้านล่าง

เริ่มต้น

1. โคลนที่เก็บ

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

2. ติดตั้งการพึ่งพา

$ pnpm install

3. คัดลอกไฟล์ .env.example ไปยัง .env และเปิดด้วยตัวแก้ไขข้อความที่คุณชื่นชอบเพื่อเติมตัวแปรสภาพแวดล้อมของคุณ

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

ในไฟล์ตัวแปรสภาพแวดล้อมนี้ตรวจสอบให้แน่ใจว่าอย่างน้อยกรอกข้อมูลใน DATABASE_URL , NEXTAUTH_URL และ NEXTAUTH_SECRET ตัวแปรสภาพแวดล้อมที่เหลือขึ้นอยู่กับบริการ / คุณสมบัติที่คุณต้องการใช้ ตัวอย่างเช่น Google/GitHub สำหรับการเข้าสู่ระบบ OAuth และ/หรือ Supabase สำหรับการจัดเก็บวัตถุ

4. เริ่มเซิร์ฟเวอร์!

// First time only
$ pnpm db:push

// dev
$ pnpm dev

// prod
$ pnpm build
$ pnpm start

- นักเทียบท่า

นอกจากนี้คุณยังสามารถเป็นเจ้าภาพ burigkasten ด้วย Docker ในการทำเช่นนั้นคุณต้อง:

1. ติดตั้ง docker และ docker-compose
2. โคลนที่เก็บและคัดลอกไฟล์ .env.example ไปยังไฟล์. .env
   1. ที่นี่คุณต้องกรอก DATABASE_URL และ NEXTAUTH_* ตัวแปรสภาพแวดล้อมอย่างน้อยที่สุด
   2. DATABASE_URL สำหรับคอนเทนเนอร์ postgres ควรเป็น DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable
3. เรียกใช้ docker-compose up -d ในรูทของที่เก็บ สิ่งนี้จะเริ่มต้นแอปพลิเคชันเช่นเดียวกับฐานข้อมูลสำหรับคุณ
4. หลังจากการเริ่มต้นเริ่มต้นคุณยังต้องเพาะเมล็ดฐานข้อมูลด้วยตนเอง สิ่งนี้ทำได้ง่ายที่สุดผ่านคอนเทนเนอร์แอพ ( bk-app )
   1. เรียกใช้ docker exec -it bk-app /bin/bash เพื่อเข้าสู่เซสชันเทอร์มินัลภายในคอนเทนเนอร์
   2. จากนั้นเรียกใช้ pnpm db:push ภายในภาชนะ สิ่งนี้จะผลักดันสคีมาฐานข้อมูลจาก PRISMA ไปยังฐานข้อมูลที่กำหนดค่า
5. ตอนนี้แอปพลิเคชันและฐานข้อมูลของคุณควรเปิดใช้งานที่ค่าเริ่มต้น http://localhost:3000

รายละเอียดเพิ่มเติมสามารถพบได้ในส่วน Docker ของเอกสาร

- ที่เกี่ยวข้อง

- บันทึกจากเมนูแชร์ Android

ด้วยแอปพลิเคชั่น HTTP แบบโอเพนซอร์ซนี้คุณสามารถสร้างรายการ "แชร์เมนู" ซึ่งดำเนินการตามคำขอ POST ด้วยอินพุตแบบไดนามิกเช่น URL และชื่อเรื่องของหน้าเว็บ ทำให้ง่ายต่อการแบ่งปันรายการจากโทรศัพท์ของคุณไปยัง brigekasten! ข้อมูลเพิ่มเติมในเอกสาร

- ส่วนขยายเบราว์เซอร์

มีส่วนขยายเบราว์เซอร์คู่หูในงานที่คุณสามารถใช้เพื่อเพิ่มเว็บไซต์ลงในห้องนิรภัยของคุณในขณะที่เรียกดูเว็บ มันสามารถพบได้ที่ ndom91/briefkasten-extension และในร้านค้าส่วนขยาย Chrome รายละเอียดเพิ่มเติมในที่เก็บข้อมูลนั้น

?? งานสกรีนช็อต

นอกจากนี้ยังมีงานพื้นหลังที่จะเติมบุ๊คมาร์คซึ่งไม่มีภาพที่ถูกต้อง มันสามารถพบได้ในที่เก็บของ ndom91/briefkasten-scrape งานนี้ทำงานทุก 2 ชั่วโมงในการกระทำของ GitHub และประมวลผลบุ๊กมาร์ก 10 ครั้งในแต่ละครั้ง

- การบริจาค

โครงการนี้เปิดให้มีการมีส่วนร่วมใด ๆ และทั้งหมด! โปรดยึดติดกับการตั้งค่า ESLINT / PRETTIER และฉันยินดีที่จะดูปัญหา / PR ของคุณ?

ใบอนุญาต

มิกซ์