briefkasten

? Бортокастен

Бруткастен (en: почтовый ящик) - Am Hausder Wohnungseingang Angebrachter Behälter für die dem empfänger ZugeStellten [post] Sendungen

Самостоятельное приложение для закладки. Работает с любой базой данных, совместимой с PRISMA (MySQL, Postgres, SQLite и т. Д.)

Предупреждение

Bortkasten V2 в настоящее время доступен в бета -версии по адресу https://dev.briefkastenhq.com

После бета -периода база данных будет отброшена , так что мы можем перенести все существующие данные из текущего (v1) briefkastenhq.com на новую версию. Я уже работаю над новыми документами, но документы V1, конечно, все еще доступны. Если вы найдете какие-либо ошибки или иным образом хотите помочь, вы можете внести свой вклад в ndom91/sveltekasten или ndom91/briefkasten-docs .

Бесплатный экземпляр: Bortkastenhq.com [Docs]

? Скриншоты

? Функции

• Сохранить по расширению браузера
• Автоматическое название и описание извлечения
• Перетаскивать URL-адреса на странице, чтобы сохранить
• Комплект клавиш
• Организовывать по категориям и тегам
• Импорт и экспортные закладки из стандартного формата HTML
• Закладка изображений, получая фоновую работу
• Несколько просмотров
• Полный текст поиск
• REST API
• OAuth + электронная почта Magic Link Login

? Предварительные условия

Для самостоятельного приложения вам понадобится следующая Thins:

1. Платформа сервера / хостинга для приложения Next.js (то есть Vercel / NetLify)
2. Для входа в систему OAuth, учетная запись разработчика в любом из поставщиков, поддерживаемых NextAuth.js
3. База данных, которая работает с Prisma (то есть MySQL, Postgres, SQLite и т. Д.)
4. Пространство хостинга изображений (то есть Supabase / ImageKit / Cloudarians) ( необязательно )

Все они относительно просты, кроме изображения. Это было выбрано, чтобы избежать размещения изображений в базу данных. Пример приложения на bortkastenhq.com использует хранилище Supabase, но любой другой подобный поставщик, такой как Cloudaric или простое ведро 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

? Докер

Вы также можете самостоятельно самоуправлять бруткой с докером. Для этого вы должны:

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 Docs.

? Связанный

? Сохранить из меню Android Share

Благодаря этому приложению с открытым исходным кодом HTTP вы можете создать элемент «Share Menu», который выполняет запрос POST с динамическим вводом, то есть URL и заголовка веб-страницы. Это очень легко обмениваться предметами с вашего телефона в Bortkasten! Больше информации в документах.

? Расширение браузера

В работах есть расширение браузера, которое вы можете использовать для добавления веб -сайтов в свое хранилище при просмотре Интернета. Его можно найти в ndom91/briefkasten-extension и в магазине расширения Chrome. Более подробная информация в этом репозитории.

? ‍? Скриншот

Существует также фоновая работа, чтобы заполнить закладки, которые не имеют достоверного изображения. Его можно найти в репозитории ndom91/briefkasten-scrape . Эта работа проходит каждые 2 часа в действии GitHub и обрабатывает 10 закладок за раз.

? Внося

Этот проект открыт для всех вкладов! Пожалуйста, придерживайтесь настройки Eslint / Creater, и я буду рад взглянуть на вашу проблему / PR?

Лицензия

Грань