el.xwx.moe/README.md

109 lines
5.4 KiB
Markdown
Raw Normal View History

2023-06-28 21:23:04 -05:00
<div align="center">
2023-08-15 20:29:38 -05:00
<img src="./assets/logo.png" width="100px" />
2023-07-31 00:54:53 -05:00
<h1>Linkwarden</h1>
2023-06-28 21:23:04 -05:00
2023-07-31 01:17:48 -05:00
<a href="https://discord.com/invite/CtuYV47nuJ"><img src="https://img.shields.io/discord/1117993124669702164?logo=discord&style=flat-square" alt="Discord"></a>
2023-10-11 17:50:19 -05:00
<img alt="GitHub commits since latest release (by SemVer including pre-releases)" src="https://img.shields.io/github/commits-since/linkwarden/linkwarden/v1.1.0/dev">
2023-07-31 01:17:48 -05:00
<img src="https://img.shields.io/github/languages/top/linkwarden/linkwarden?style=flat-square" alt="Top Language">
<img src="https://img.shields.io/github/stars/linkwarden/linkwarden?style=flat-square" alt="Github Stars">
2023-07-31 00:54:53 -05:00
</div>
<div align='center'>
2023-06-28 21:23:04 -05:00
2023-11-20 14:58:32 -06:00
[Website](https://linkwarden.app) | [Getting Started](https://docs.linkwarden.app) | [Features](https://github.com/linkwarden/linkwarden#features) | [Roadmap](https://github.com/orgs/linkwarden/projects/1) | [Support ❤](https://github.com/linkwarden/linkwarden#support-)
2023-06-28 21:23:04 -05:00
</div>
2022-06-09 15:17:00 -05:00
2023-07-31 00:54:53 -05:00
## Intro & motivation
**Linkwarden is a self-hosted, open-source collaborative bookmark manager to collect, organize and archive webpages.** The objective is to organize useful webpages and articles you find across the web in one place, and since useful webpages can go away (see the inevitability of [Link Rot](https://www.howtogeek.com/786227/what-is-link-rot-and-how-does-it-threaten-the-web/)), Linkwarden also saves a copy of each webpage as a Screenshot and PDF, ensuring accessibility even if the original content is no longer available.
2023-07-31 05:52:27 -05:00
2023-07-31 00:54:53 -05:00
Additionally, Linkwarden is designed with collaboration in mind, sharing links with the public and/or allowing multiple users to work together seamlessly.
2023-11-20 15:03:38 -06:00
> [!TIP]
> Our official [Cloud](https://linkwarden.app/#pricing) offering provides the simplest way to begin using Linkwarden and it's the preferred choice for many due to its time-saving benefits. <br> Your subscription supports our hosting infrastructure and ongoing development. <br> Alternatively, if you prefer [self-hosting](https://docs.linkwarden.app/self-hosting/installation) Linkwarden, no problem! You'll still have access to all the premium features.
2023-11-20 14:58:32 -06:00
<img src="./assets/dashboard.png" />
<div align="center">
2023-11-23 04:20:21 -06:00
<img src="./assets/all_links.png" width="32%" />
2023-11-20 14:58:32 -06:00
2023-11-23 04:20:21 -06:00
<img src="./assets/all_collections.png" width="32%" />
2023-11-20 14:58:32 -06:00
2023-11-23 04:20:21 -06:00
<img src="./assets/manage_team.png" width="32%" />
2023-11-20 14:58:32 -06:00
2023-11-23 04:20:21 -06:00
<img src="./assets/readable_view.png" width="32%" />
2023-11-20 14:58:32 -06:00
<img src="./assets/public_page.png" width="32%" />
<img src="./assets/light_mode.png" width="32%" />
</div>
2023-07-31 01:17:48 -05:00
2023-07-31 00:54:53 -05:00
<details>
<summary><b>A bit of a "history"</b></summary>
Linkwarden has been completely rebuilt and redesigned from ground up, so pretty much the only thing it has in common with its predecessor is the idea behind it - bookmark management.
**What happened to the old version?**
2023-11-20 14:58:32 -06:00
We've forked the old version from the current repository into [this repo](https://github.com/linkwarden/linkwarden-old).
2023-07-31 00:54:53 -05:00
</details>
## Features
2023-11-07 16:55:11 -06:00
- 📸 Auto capture a screenshot, PDF, and readable view of each webpage.
- 🏛️ Send your webpage to Wayback Machine ([archive.org](https://archive.org)) for a snapshot. (Optional)
2023-09-26 01:39:23 -05:00
- 📂 Organize links by collection, name, description and multiple tags.
- 👥 Collaborate on gathering links in a collection.
- 🔐 Customize the permissions of each member.
2023-11-23 14:43:38 -06:00
- 🌐 Share your collected links and preserved formats with the world.
2023-09-26 01:39:23 -05:00
- 📌 Pin your favorite links to dashboard.
2023-11-07 16:55:11 -06:00
- 🔍 Full text search, filter and sort for easy retrieval.
- 📱 Responsive design and supports most modern browsers.
2023-09-26 01:39:23 -05:00
- 🌓 Dark/Light mode support.
2023-11-07 16:55:11 -06:00
- 🧩 Browser extension, managed by the community. [Star it here!](https://github.com/linkwarden/browser-extension)
2023-10-05 14:04:22 -05:00
- ⬇️ Import your bookmarks from other browsers.
2023-11-07 16:55:11 -06:00
- ⚡️ Powerful API.
2023-11-23 14:43:38 -06:00
- 🔐 SSO and Keycloak integration. (Enterprise and Self-hosted users only)
- ✅ And many more features!
2023-07-31 00:54:53 -05:00
2023-10-10 04:28:26 -05:00
## Suggestions
2023-11-07 16:55:11 -06:00
We _usually_ go after the [popular suggestions](https://github.com/linkwarden/linkwarden/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc). Feel free to open a [new issue](https://github.com/linkwarden/linkwarden/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=) to suggest one - others might be interested too! :)
2023-10-10 04:28:26 -05:00
2023-07-31 00:54:53 -05:00
## Roadmap
2023-09-05 13:12:27 -05:00
Make sure to check out our [public roadmap](https://github.com/orgs/linkwarden/projects/1).
2023-07-31 23:50:28 -05:00
## Docs
2023-08-03 18:48:23 -05:00
For information on how to get started or to set up your own instance, please visit the [documentation](https://docs.linkwarden.app).
2023-09-26 01:39:23 -05:00
## Main Tech Stack
- NextJS
- TypeScript
- Tailwind
- Prisma
- Zustand
2023-07-31 00:54:53 -05:00
## Development
2023-09-26 02:32:08 -05:00
If you want to contribute, Thanks! Start by checking our [public roadmap](https://github.com/orgs/linkwarden/projects/1), there you'll see a [README for contributers](https://github.com/orgs/linkwarden/projects/1?pane=issue&itemId=34708277) for the rest of the info on how to contribute to this repo.
2023-07-31 00:54:53 -05:00
## Security
2023-07-31 07:08:52 -05:00
If you found a security vulnerability, please do **not** create a public issue, instead send an email to [security@linkwarden.app](mailto:security@linkwarden.app) stating the vulnerability. Thanks!
2023-07-31 00:54:53 -05:00
## Support ❤
2023-10-09 12:06:24 -05:00
Other than using our official [Cloud](https://linkwarden.app/#pricing) offering, any [donations](https://opencollective.com/linkwarden) are highly appreciated as well!
2023-07-31 00:54:53 -05:00
Here are the other ways to support/cheer this project:
2023-07-31 00:54:53 -05:00
2023-10-10 04:28:26 -05:00
- Starring this repository.
2023-07-31 09:43:55 -05:00
- Joining us on [Discord](https://discord.com/invite/CtuYV47nuJ).
2023-07-31 00:54:53 -05:00
- Referring Linkwarden to a friend.
If you did any of the above, Thanksss! Otherwise thanks.