mirror of
https://github.com/Kareadita/Kavita.git
synced 2025-07-09 03:04:19 -04:00
c52ed1f65d
Co-authored-by: Stepan Goremykin <s.goremykin@proton.me> Co-authored-by: goremykin <goremukin@gmail.com> Co-authored-by: Christopher <39032787+MrRobotjs@users.noreply.github.com> Co-authored-by: Fesaa <77553571+Fesaa@users.noreply.github.com>
117 lines
6.7 KiB
Markdown
117 lines
6.7 KiB
Markdown
# [<img src="/Logo/kavita.svg" width="32" alt="">]() Kavita
|
|
<div align="center">
|
|
|
|
|
|
|
|
Kavita is a fast, feature rich, cross-platform reading server. Built with a focus for being a full solution for all your reading needs. Set up your own server and share
|
|
your reading collection with your friends and family!
|
|
|
|
[](https://github.com/Kareadita/Kavita/releases)
|
|
[](https://github.com/Kareadita/Kavita/blob/master/LICENSE)
|
|
[](https://github.com/Kareadita/Kavita/releases)
|
|
[](https://hub.docker.com/r/jvmilazz0/kavita)
|
|
[](https://sonarcloud.io/dashboard?id=Kareadita_Kavita)
|
|
[](https://sonarcloud.io/dashboard?id=Kareadita_Kavita)
|
|
[](#backers)
|
|
[](#sponsors)
|
|
<a href="https://hosted.weblate.org/engage/kavita/">
|
|
<img src="https://hosted.weblate.org/widgets/kavita/-/ui/svg-badge.svg" alt="Translation status" />
|
|
</a>
|
|
<img src="https://img.shields.io/endpoint?url=https://stats.kavitareader.com/api/ui/shield-badge"/>
|
|
</div>
|
|
|
|
|
|
## What Kavita Provides
|
|
- Serve up Manga/Webtoons/Comics (cbr, cbz, zip/rar/rar5, 7zip, raw images) and Books (epub, pdf)
|
|
- First class responsive readers that work great on any device (phone, tablet, desktop)
|
|
- Customizable theming support: [Theme Repo](https://github.com/Kareadita/Themes) and [Documentation](https://wiki.kavitareader.com/guides/themes)
|
|
- External metadata integration and scrobbling for read status, ratings, and reviews (available via [Kavita+](https://wiki.kavitareader.com/kavita+))
|
|
- Rich Metadata support with filtering and searching
|
|
- Ways to group reading material: Collections, Reading Lists (CBL Import), Want to Read
|
|
- Ability to manage users with rich Role-based management for age restrictions, abilities within the app, etc
|
|
- Rich web readers supporting webtoon, continuous reading mode (continue without leaving the reader), virtual pages (epub), etc
|
|
- Ability to customize your dashboard and side nav with smart filters, custom order and visibility toggles
|
|
- Full Localization Support
|
|
- Ability to download metadata (available via [Kavita+](https://wiki.kavitareader.com/kavita+))
|
|
|
|
|
|
## Support
|
|
[](https://discord.gg/eczRp9eeem)
|
|
[](https://github.com/Kareadita/Kavita/issues)
|
|
|
|
## Demo
|
|
If you want to try out Kavita, a demo is available:
|
|
[https://demo.kavitareader.com/](https://demo.kavitareader.com/login?apiKey=9003cf99-9213-4206-a787-af2fe4cc5f1f)
|
|
```
|
|
Username: demouser
|
|
Password: Demouser64
|
|
```
|
|
|
|
## Setup
|
|
The easiest way to get started is to visit our Wiki which has up-to-date information on a variety of
|
|
install methods and platforms.
|
|
[https://wiki.kavitareader.com/getting-started](https://wiki.kavitareader.com/getting-started)
|
|
|
|
## Feature Requests
|
|
Got a great idea? Throw it up on [Discussions](https://github.com/Kareadita/Kavita/discussions/2529) or vote on another idea. Many great features in Kavita are driven by our community.
|
|
|
|
## Notice
|
|
Kavita is being actively developed and should be considered beta software until the 1.0 release.
|
|
Kavita may be subject to changes in how the platform functions as it is being built out toward the
|
|
vision. You may lose data and have to restart. The Kavita team strives to avoid any data loss.
|
|
|
|
## Donate
|
|
If you like Kavita, have gotten good use out of it, or feel like you want to say thanks with a few bucks, feel free to donate. Money will go towards
|
|
expenses related to Kavita. Back us through [OpenCollective](https://opencollective.com/Kavita#backer). You can also use [Paypal](https://www.paypal.com/paypalme/majora2007?locale.x=en_US), however your name will not show below. Kavita+ is also an
|
|
option which provides funding, and you get a benefit.
|
|
|
|
## Kavita+
|
|
[Kavita+](https://wiki.kavitareader.com/kavita+) is a paid subscription that offers premium features that otherwise wouldn't be feasible to include in Kavita. It is ran and operated by majora2007, the creator and developer of Kavita.
|
|
|
|
If you are interested, you can use the promo code `FIRSTTIME` for your initial signup for a 50% discount on the first month (2$). This can be thought of as donating to Kavita's development and getting some sweet features out of it.
|
|
|
|
**If you already contribute via OpenCollective, please reach out to majora2007 for a provisioned license.**
|
|
|
|
## Localization
|
|
Thank you to [Weblate](https://hosted.weblate.org/engage/kavita/) who hosts our localization infrastructure pro bono. If you want to see Kavita in your language, please help us localize.
|
|
|
|
<a href="https://hosted.weblate.org/engage/kavita/">
|
|
<img src="https://hosted.weblate.org/widget/kavita/horizontal-auto.svg" alt="Translation status" />
|
|
</a>
|
|
|
|
## PikaPods
|
|
If you are looking to try your hand at self-hosting but lack the machine, [PikaPods](https://www.pikapods.com/pods?run=kavita) is a great service that
|
|
allows you to easily spin up a server. 20% of app revenues are contributed back to Kavita via OpenCollective.
|
|
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute and downstream library maintainers. [Contribute](CONTRIBUTING.md).
|
|
<a href="https://github.com/Kareadita/Kavita/graphs/contributors">
|
|
<img src="https://opencollective.com/kavita/contributors.svg?width=890&button=false&avatarHeight=42" />
|
|
</a>
|
|
|
|
|
|
## Backers
|
|
|
|
Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/Kavita#backer)
|
|
|
|
<img src="https://opencollective.com/kavita/backers.svg?width=890&avatarHeight=42"></a>
|
|
|
|
## Sponsors
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/Kavita#sponsor)
|
|
|
|
<img src="https://opencollective.com/Kavita/sponsors.svg?width=890"></a>
|
|
|
|
## Mega Sponsors
|
|
<img src="https://opencollective.com/Kavita/tiers/mega-sponsor.svg?width=890"></a>
|
|
|
|
## Powered By
|
|
[](https://jb.gg/OpenSource)
|
|
|
|
### License
|
|
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
|
* Copyright 2020-2024
|
|
|