- ๐ Introduction
- ๐ฅ Quick Links
- ๐บ Demo Video
- ๐ Features
- ๐ Development
- ๐ Acknowledgements
Regreso is an open source tool for creating, finding, and managing the links, files, and resources you wish to "return" to later.
These destinations may be organized into "maps", enabling graphing and visualization of relationships, "tags", project or topic-centered "trunk" workspaces, and eventually session "journies".
Note
Visit the wiki for a feature overview or UI showcase. If it interests you, leave a โญ!
๐ค Philosophy:
Regreso aims to create a new form of anti-productivity application which encourages the rejection of traditional notetaking, project management, and organization products. Acting as an extension of the user's mind, Regreso aims to provide maximum freedom, extensibility, and customization.
2025-01-18.22-36-07.mp4
- ๐ Destinations (links) and ๐บ Maps (lists)
- ๐ Powerful text or tag- based search (#50)
- ๐ผ Workspaces and archival (#111)
- ๐ Email, GitHub SSO, webauthn 2FA (#8)
- ๐ Knowledge, landing, blog website (#28)
- ๐ง AI-powered auto-tagging (#336)
- ๐ Light/dark UI modes (#27)
- ๐ Simple REST API (#83)
- ๐ GitHub Wiki-based documentation
- ๐ PostHog Analytics (#85)
- โจ Raycast Extension client
Regreso is licensed under the MIT license, a permissive license which allows you to modify, fork, extend, or redistribute the source code.
We accept contributions of new features and bug fixes through Pull Requests and general suggestions/bug reports through Issues. Before opening either of these, please check if a similar issue/PR has already been opened/assigned and if unsure about its assignment/development status, please ask before potentially creating a duplicate.
For security reports, please submit a private vulnerability disclosure with the relevant information!
To fork/extend Regreso, it is recommended that you use Supabase or any other Postgres database provider. To develop locally, you can run the start-database.sh
file to easily create a new Postgres database with Docker. Alternatively, the setup.sql
provides the full database schema.
Many environment variables are also required for Regreso development. These are also documented in the .env.example
file.
To install dependencies, run pnpm install
and to build/start server, use pnpm run dev
or pnpm run build && pnpm run start
.
Regreso has a detailed roadmap hosted as a github project. Additionally, key upcoming work includes rss compatibility, local support, a mobile app, and auth/api overhaul. Follow open pull requests to keep up with progress!
- Framework: Next.js 15 + App Router + Typescript
- Design System: Tailwind + Radix UI + shadcn-ui
- Backend: tRPC + Lucia Auth + Drizzle
- Services: Upload Thing, Supabase, Netlify, PostHog
- UI: TipTap, DND Kit, Emoji Mart, Boring Avatars, Lucide Icons
- Libraties: React Query + Zod
- DX: pnpm, Million Lint, All Contributors
Thanks goes to these wonderful people (emoji key):
Mat Manna ๐ป ๐ ๐ ๐ ๐ ๐ ๐จ ๐ค ๐ง ๐ ๐น |
||||||
|
This project follows the all-contributors specification. Contributions of any kind welcome!