9f17f5daa7
* Implemented the ability to login to the app by passing apiKey to the login. This is for an upcoming feature (but currently blocked by another story) * Added a comment * Ensure locales are sorted * Added a new status badge that shows how many active installs we have via users that use stats. * Bump all GA to latest versions * Bumped dependencies * Bumped backend notifications * Updated ngx-pdf-reader to upcoming beta which fixes some PDFs taking time to load. PDF reader will use browser locale to load localization rather than Kavita locale for now. * Downgraded pdf viewer as beta has lots of bugs.
127 lines
7.3 KiB
Markdown
127 lines
7.3 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. Setup 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/kizaing/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)
|
|
- Dark mode and customizable theming support
|
|
- External metadata integration and scrobbling for read status, ratings, and reviews (available via 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
|
|
- Full Localization Support
|
|
|
|
|
|
## Support
|
|
[](https://www.reddit.com/r/KavitaManga/)
|
|
[](https://discord.gg/eczRp9eeem)
|
|
[](https://github.com/Kareadita/Kavita/issues)
|
|
|
|
## Demo
|
|
If you want to try out Kavita, we have a demo up:
|
|
[https://demo.kavitareader.com/](https://demo.kavitareader.com/)
|
|
```
|
|
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/en/install](https://wiki.kavitareader.com/en/install)
|
|
|
|
**Note: Kavita is under heavy development and is being updated all the time, so the tag for bleeding edge builds is `:nightly`. The `:latest` tag will be the latest stable release.**
|
|
|
|
## Feature Requests
|
|
Got a great idea? Throw it up on our [Feature Request site](https://feats.kavitareader.com/) or vote on another idea. Please check the [Project Board](https://github.com/Kareadita/Kavita/projects) first for a list of planned features before you submit an idea.
|
|
|
|
## 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+
|
|
[Kavita+](https://wiki.kavitareader.com/en/kavita-plus) 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 me for a provisioned license.**
|
|
|
|
|
|
## 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>
|
|
|
|
## JetBrains
|
|
Thank you to [<img src="/Logo/jetbrains.svg" alt="" width="32"> JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools.
|
|
|
|
* [<img src="/Logo/rider.svg" alt="" width="32"> Rider](http://www.jetbrains.com/rider/)
|
|
* [<img src="/Logo/dottrace.svg" alt="" width="32"> dotTrace](http://www.jetbrains.com/dottrace/)
|
|
|
|
## Palace-Designs
|
|
We would like to extend a big thank you to [<img src="/Logo/hosting-sponsor.png" alt="" width="128">](https://www.palace-designs.com/) who hosts our infrastructure pro-bono.
|
|
|
|
## 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/widgets/kavita/-/horizontal-blue.svg" alt="Translation status" />
|
|
</a>
|
|
|
|
## Huntr
|
|
We would like to extend a big thank you to [Huntr](https://huntr.dev/repos/kareadita/kavita) who has worked with Kavita in reporting security vulnerabilities. If you are interested in
|
|
being paid to help secure Kavita, please give them a try.
|
|
|
|
## 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.
|
|
|
|
### License
|
|
|
|
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
|
* Copyright 2020-2023
|
|
|