goniszewski/grimoire
Fork: 61 Star: 2063 (更新于 2024-11-04 01:04:38)
license: MIT
Language: TypeScript .
Bookmark manager for the wizards 🧙
最后发布版本: v0.4.2 ( 2024-09-28 04:20:34)
Grimoire
Bookmark manager for the wizards 🧙
[!IMPORTANT] Version
0.4
introduces a new approach for data storage and user authorization. If you are upgrading from version0.3.X
you may want to utilize the built-in migration tool (read more).
Glimpse into the magical book of your forbidden knowledge - Grimoire! 📖💫
Unleash your inner sorcerer and conquer the chaos of bookmarks! With Grimoire, you'll have a bewitching way to store and sort your enchanted links.
But wait, there's more!
Transmute your saved pages into juicy content snippets with our mystical extraction feature. Embrace the magic, tame the clutter, and let Grimoire be your mystical companion in the vast library of the web.
It's time to conjure up some organization! 📚✨
Features
- add and organize bookmarks easily 🔖
- create new user accounts, each with their own bookmarks, categories and tags 🙋
- fuzzy search through bookmarks 🔍
- supports tags and categories 🏷️
- fetch metadata from websites, store it locally and update it when needed 🌐
- add your personal notes to bookmarks 📝
- integration API to add bookmarks from other sources 🧰
- embrace the night with a dark mode 🌙
- and stay productive using our official browser extension, grimoire companion (available here) 🪄
Screenshots
Light Mode | Dark Mode |
---|---|
Show only unread | Adding new bookmark |
User Profile view | Bookmark details |
More screenshots can be found in the screenshots directory.
Installation
Run using Docker Compose (recommended)
Prerequisites
Steps
- Create a
docker-compose.yml
file with the following content:
services:
grimoire:
image: goniszewski/grimoire:latest # or change from 'latest' to 'preview' to use the latest preview version
container_name: grimoire
restart: unless-stopped
environment:
- PORT=5173
- PUBLIC_HTTPS_ONLY=false
- PUBLIC_SIGNUP_DISABLED=false
volumes:
- grimoire_data:/app/data/
build:
context: .
dockerfile: Dockerfile
healthcheck:
test: wget --no-verbose --tries=1 --spider http://localhost:$PORT/api/health || exit 1
interval: 30s
timeout: 10s
retries: 3
ports:
- '${PORT:-5173}:${PORT:-5173}'
volumes:
grimoire_data:
- [Optional] Update the environment variables to match your needs.
- Run the app using
docker compose up -d
command.
[!NOTE] For the recommended setup, only the
docker-compose.yml
file is required.
Run app using Node
Prerequisites
Steps
# Clone the repository
git clone https://github.com/goniszewski/grimoire
# Rename the `.env.example` file to `.env`
# "mv .env.example .env" on Linux/MacOS, "ren .env.example .env" on Windows
# Install the dependencies
pnpm i
# Run the app
chmod +x ./run-dev.sh && ./run-dev.sh
[!TIP] Although the above setups are intended for development, they are also suitable for daily use. For a better experience, it is recommended to use a Node.js process manager, such as PM2.
Development
Check out the development guide to learn how to set up the project for development.
Roadmap
- Initial relase (0.1.0) 🚀
- Official Docker image 🐳
- Add Integration API 🧰
- Official browser extension (repository) 🪄
- Bookmark import and export features 💼
- AI features, like generated descriptions and tags suggestions 🤖
- Public User profiles & bookmark sharing 🌍
- Flows - a way to keep bookmarks in a session-like order with related notes (e.g. for learning, research, etc.) ✨
- ...and more to come! 🧙
We're open to suggestions and feature requests! If you have an idea for a feature, please open an issue or start a discussion.
Contributing
If you want to contribute to the project, please read the contributing guide.
License
This project is licensed under the MIT License.
Credits
Special thanks to: @extractus/article-extractor, Bun, DaisyUI, Drizzle, Fuse.js, Lucia, MetaScraper, PocketBase, sanitize-html, SvelteKit, Svelte Select, Svelte French Toast, Swagger UI, Tabler Icons, Tailwind CSS, url-metadata
最近版本更新:(数据更新于 2024-10-13 00:20:17)
2024-09-28 04:20:34 v0.4.2
2024-09-23 22:38:33 v0.4.1-hotfix.3
2024-09-21 06:43:28 v0.4.1-hotfix.2
2024-09-21 06:13:05 v0.4.1-hotfix.1
2024-09-21 04:58:58 v0.4.1
2024-09-19 04:05:47 v0.4.0
2024-09-17 03:14:55 v0.4.0-pre.4
2024-09-14 02:19:20 v0.4.0-pre.3
2024-09-04 02:49:11 v0.4.0-pre.2
2024-08-22 04:05:21 v0.4.0-pre.1
主题(topics):
bookmarks, bookmarks-manager, docker, self-hosted, svellte, sveltekit, tailwindcss, typescript
goniszewski/grimoire同语言 TypeScript最近更新仓库
2024-11-05 17:55:23 langgenius/dify
2024-11-05 17:35:52 siyuan-note/siyuan
2024-11-05 16:59:32 laurent22/joplin
2024-11-05 12:39:27 lobehub/lobe-chat
2024-11-05 11:52:31 RSSNext/Follow
2024-11-05 07:18:03 microsoft/genaiscript