briefkasten

? Breve

Brevekasten (en: buzón) - am haus -oder wohnungseingang angebrachter behälter für die dem empfänger zugestellten [post] sendungen

Aplicación de marcadores autohospedada. Funciona con cualquier base de datos compatible con Prisma (MySQL, Postgres, SQLite, etc.)

Advertencia

BRITKASTEN V2 está actualmente disponible en beta en https://dev.briefkastenhq.com

Después del período beta, la base de datos se eliminará , de modo que podamos migrar todos los datos existentes del briefkastenhq.com actual (V1) a la nueva versión. Ya estoy trabajando en los nuevos documentos, pero los documentos V1 todavía están disponibles. Si encuentra algún error, o desea ayudar, puede contribuir en ndom91/sveltekasten o ndom91/briefkasten-docs .

Instancia libre: brevekastenhq.com [documentos]

? Capturas de pantalla

? Características

• Guardar por extensión del navegador
• Título automático y extracción de descripción
• URL de arrastrar y soltar en la página para guardar
• Atajos de teclado
• Organizar por categorías y etiquetas
• Importar y exportar marcadores de formato HTML estándar
• Imagen de marcador para obtener trabajo de fondo
• Múltiples vistas
• Búsqueda de texto completo
• API REST
• OAuth + correo electrónico Magic Link Iniciar sesión

? Requisitos previos

Para autoestima esta aplicación, necesitará el siguiente thins:

1. Servidor / plataforma de alojamiento para una aplicación Next.js (es decir, Vercel / Netlify)
2. Para OAuth Login, una cuenta de desarrollador en cualquiera de los proveedores respaldados por NextAuth.js
3. Base de datos que funciona con Prisma (es decir, MySQL, Postgres, SQLite, etc.)
4. Espacio de alojamiento de imágenes (es decir, Supabase / ImageKit / Cloudinary) ( opcional )

Todos estos son relativamente sencillos, aparte de la imagen Hoster. Esto fue elegido para evitar poner las imágenes en la base de datos. La aplicación de ejemplo en bortkastenhq.com es utilizar el almacenamiento de Supabase, pero cualquier otro proveedor similar como Cloudinary o un simple cubo S3 también haría el trabajo. Elegí Supabase, porque tienen un SDK fácil de usar, un nivel gratuito decente, y ya estaba usando su servicio Postgres.

Después de que tenga una configuración de cuenta en todos los proveedores anteriores, o tenga su propia infraestructura lista, puede continuar con los próximos pasos a continuación.

Empezando

1. Clonar el repositorio

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

2. Instalar dependencias

$ pnpm install

3. Copie el archivo .env.example a .env y ábralo con su editor de texto favorito para completar sus variables de entorno.

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

En este archivo de variables de entorno, asegúrese de completar al menos DATABASE_URL , NEXTAUTH_URL y NEXTAUTH_SECRET . El resto de las variables de entorno dependen de los servicios / características que desea utilizar. Por ejemplo, Google/GitHub para el inicio de sesión de OAuth y/o Supabase para el almacenamiento de objetos.

4. ¡Inicie el servidor!

// First time only
$ pnpm db:push

// dev
$ pnpm dev

// prod
$ pnpm build
$ pnpm start

? Estibador

También puedes autohospedar brevekasten con Docker. Para hacerlo, debes:

1. Instale docker y docker-compose .
2. Clonar el repositorio y copiar el archivo .env.example al archivo .env .
   1. Aquí también debe completar las variables de entorno DATABASE_URL y NEXTAUTH_* como mínimo.
   2. La DATABASE_URL para el contenedor Postgres debe ser DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable
3. Ejecute docker-compose up -d en la raíz del repositorio. Esto iniciará la aplicación y la base de datos para usted.
4. Después del inicio inicial, aún debe sembrar manualmente la base de datos. Esto se hace más fácilmente a través del contenedor de aplicaciones ( bk-app ).
   1. Ejecute docker exec -it bk-app /bin/bash para ingresar una sesión de terminal dentro del contenedor.
   2. Luego ejecute pnpm db:push dentro del contenedor. Esto empujará el esquema de la base de datos del prisma a la base de datos configurada.
5. Ahora su aplicación y base de datos deben estar en funcionamiento al valor predeterminado http://localhost:3000

Se pueden encontrar más detalles en la sección Docker de los documentos.

? Relacionado

? Guardar en el menú de compartir Android

Con esta aplicación de código abierto HTTP atajos, puede crear un elemento de "menú Compartir" que ejecute una solicitud POST con entrada dinámica, es decir, la URL y el título de una página web. ¡Esto hace que sea muy fácil compartir elementos de su teléfono a brevekasten! Más información en los documentos.

? Extensión del navegador

Hay una extensión de navegador complementaria en las obras que puede usar para agregar sitios web a su bóveda mientras navega por la web. Se puede encontrar en ndom91/briefkasten-extension y en la tienda de extensión de Chrome. Más detalles en ese repositorio.

? ‍? Trabajo de captura de pantalla

También hay un trabajo de fondo para completar marcadores que no tienen una imagen válida. Se puede encontrar en el repositorio ndom91/briefkasten-scrape . Este trabajo se ejecuta cada 2 horas en una acción de GitHub y procesa 10 marcadores a la vez.

? Que contribuye

¡Este proyecto está abierto a todas y cada una de las contribuciones! Por favor, quede con la configuración de Eslint / Prettier y estaré encantado de echar un vistazo a su problema / relaciones públicas.

Licencia

MIT