briefkasten

? Briefkasten

Briefkasten (EN: Caixa de correio) - AM HAUSODER WOHNUNGSEINGANG ANGEBRACHTER BEHälter für die dem empfänger zugestellten [post] sendungen

Aplicação de marcas de auto-hospedagem auto-hospedada. Funciona com qualquer banco de dados compatível com Prisma (MySQL, Postgres, Sqlite, etc.)

Aviso

Briefkasten V2 está atualmente disponível em beta em https://dev.briefkastenhq.com

Após o período beta, o banco de dados será retirado , para que possamos migrar todos os dados existentes do atual (V1) briefkastenhq.com para a nova versão. Já estou trabalhando nos novos documentos, mas os documentos V1 ainda estão disponíveis. Se você encontrar bugs ou, de outra forma, quiser ajudar, poderá contribuir com ndom91/sveltekasten ou ndom91/briefkasten-docs .

Instância gratuita: Briefkastenhq.com [docs]

? Capturas de tela

? Características

• Salvar por extensão do navegador
• Título automático e extração de descrição
• URLs de arrastar e soltar na página para salvar
• Atalhos de teclado
• Organizar por categorias e tags
• Importar e exportar marcadores de formato HTML padrão
• Mark -Marmark Image buscar trabalho de fundo
• Várias visualizações
• Pesquisa FullText
• Rest API
• OAuth + Email Magic Link Login

? Pré -requisitos

Para se auto-hospedar este aplicativo, você precisará dos seguintes Thins:

1. Plataforma de servidor / hospedagem para um aplicativo Next.js (ou seja, vercel / netlify)
2. Para o OAuth Login, uma conta de desenvolvedor em qualquer um dos provedores suportados pelo Nextauth.js
3. Banco de dados que funciona com prisma (ou seja, mysql, postgres, sqlite, etc.)
4. Espaço de hospedagem de imagens (por exemplo, supabase / imagekit / Cloudinary) ( opcional )

Tudo isso é relativamente direto, além da imagem Hoster. Isso foi escolhido para evitar colocar as imagens no banco de dados. O aplicativo de exemplo no BREMEKATENHQ.com está usando o Supabase Storage, mas qualquer outro provedor semelhante como Cloudinary ou um simples balde S3 também faria o trabalho. Eu escolhi o Supabase, porque eles têm um SDK fácil de usar, um nível livre decente, e eu já estava usando o serviço Postgres.

Depois de ter uma configuração de conta em todos os provedores acima ou ter sua própria infraestrutura pronta para ir, você pode continuar nas próximas etapas abaixo.

Começando

1. Clone o repositório

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

2. Instalar dependências

$ pnpm install

3. Copie o arquivo .env.example para .env e abra -o com seu editor de texto favorito para preencher suas variáveis de ambiente.

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

Neste arquivo de variáveis de ambiente, certifique -se de preencher pelo menos o DATABASE_URL , NEXTAUTH_URL e NEXTAUTH_SECRET . O restante das variáveis de ambiente depende dos serviços / recursos que você deseja usar. Por exemplo, Google/Github para OAuth Login e/ou Supabase para armazenamento de objetos.

4. Inicie o servidor!

// First time only
$ pnpm db:push

// dev
$ pnpm dev

// prod
$ pnpm build
$ pnpm start

? Docker

Você também pode se auto-host "com o Docker. Para fazer isso, você deve:

1. Instale docker e docker-compose .
2. Clone o repositório e copie o .env.example para o arquivo .env .
   1. Aqui você também precisa preencher as variáveis de ambiente DATABASE_URL e NEXTAUTH_* no mínimo.
   2. O DATABASE_URL para o contêiner do PostGres deve ser DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable
3. Execute docker-compose up -d na raiz do repositório. Isso iniciará o aplicativo e o banco de dados para você.
4. Após o início inicial, você ainda precisa semear manualmente o banco de dados. Isso é feito mais facilmente através do contêiner de aplicativos ( bk-app ).
   1. Execute docker exec -it bk-app /bin/bash para inserir uma sessão de terminal dentro do contêiner.
   2. Em seguida, execute pnpm db:push dentro do recipiente. Isso empurrará o esquema do banco de dados do prisma para o banco de dados configurado.
5. Agora, seu aplicativo e banco de dados devem estar em funcionamento no http://localhost:3000

Mais detalhes podem ser encontrados na seção Docker dos documentos.

? Relacionado

? Salvar do menu de compartilhamento Android

Com este aplicativo de código aberto HTTP Atalhos, você pode criar um item "Share Menu" que execute uma solicitação POST com entrada dinâmica, ou seja, o URL e o título de uma página da web. Isso facilita o compartilhamento de itens do seu telefone para briekaten! Mais informações nos documentos.

? Extensão do navegador

Há uma extensão do navegador complementar nos trabalhos que você pode usar para adicionar sites ao seu cofre enquanto navega na web. Pode ser encontrado no ndom91/briefkasten-extension e no Chrome Extension Store. Mais detalhes nesse repositório.

? ‍? Captura de tela

Há também um trabalho de fundo para preencher os favoritos que não têm uma imagem válida. Pode ser encontrado no repositório ndom91/briefkasten-scrape . Este trabalho funciona a cada 2 horas em uma ação do Github e processa 10 marcadores por vez.

? Contribuindo

Este projeto está aberto a todas e quaisquer contribuições! Por favor, siga as configurações de Eslint / mais bonito e ficarei feliz em dar uma olhada no seu problema / relações públicas?

Licença

Mit