el.xwx.moe/README.md

84 lines
3.7 KiB
Markdown
Raw Normal View History

2023-06-28 21:23:04 -05:00
<div align="center">
2023-07-31 00:54:53 -05:00
<img src="./assets/icon.png" width="100px" />
<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>
<img src="https://img.shields.io/github/commit-activity/m/linkwarden/linkwarden?style=flat-square" alt="Github Activity">
<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
[Homepage](https://linkwarden.app) | [Getting Started](https://docs.linkwarden.app/getting-started) | [Features](https://github.com/linkwarden/linkwarden#features) | [Roadmap](https://github.com/linkwarden/linkwarden#roadmap) | [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.
Additionally, Linkwarden is designed with collaboration in mind, sharing links with the public and/or allowing multiple users to work together seamlessly.
2023-07-31 01:17:48 -05:00
<img src="./assets/showcase_image.png" />
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?**
We highly recommend you **not** to use the old version as it is no longer maintained and has much less features. But anyway if you really wanna check it out, here it is in [this repo](https://github.com/linkwarden/linkwarden-old).
</details>
## Main Tech Stack
- NextJS
- TypeScript
- Tailwind
- Next-auth
- Prisma
## Features
- ✅ Auto capture a screenshot and a PDF of each link.
2023-07-31 00:54:53 -05:00
- ✅ Organize links by collection, name, description and multiple tags.
- ✅ Collaborate on gathering links in a collection.
2023-07-31 00:54:53 -05:00
- ✅ Customize the permissions of each member.
- ✅ Share your collected links with the world.
- ✅ Search, filter and sort by link details.
- ✅ Responsive design and supports most browsers.
2023-07-31 00:54:53 -05:00
## Roadmap
2023-07-31 01:22:47 -05:00
There are _many_ upcoming features, below are only _some_ of the 100% planned ones:
2023-07-31 00:54:53 -05:00
- 🐳 Docker version.
- 🌒 Dark mode.
- 📦 Import/Export your data.
## Docs
Currently, the Documentation is a bit targeted towards a more tech-savvy audience and has so much room to improve, you can find it [here](https://docs.linkwarden.app).
2023-07-31 00:54:53 -05:00
## Development
If you want to contribute, please start by creating an issue stating what you are going to work on based on the project roadmap.
## Security
If you found a security vulnerability, please do **not** create a public issue, instead send an email to security@linkwarden.app stating the vulnerability. Thanks!
## Support ❤
2023-07-31 01:12:25 -05:00
Any [donations](https://opencollective.com/linkwarden) are highly appreciated. <3
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
- Starring this repo.
- Joining us on Discord.
2023-07-31 01:19:49 -05:00
- Following @daniel31x13 on [Mastodon](https://mastodon.social/@daniel31x13), [Twitter](https://twitter.com/daniel31x13) and [GitHub](https://github.com/daniel31x13).
2023-07-31 00:54:53 -05:00
- Referring Linkwarden to a friend.
If you did any of the above, Thanksss! Otherwise thanks.