19e17c85fa
* Changed the default margin for mobile in book reader to 5% * Fixed a bug where checking for update did no current version validation before sending the update to the UI. * Added some documentation to the book code * Changed token expiry to 2 weeks. * Search bar will by default not have a border outline * Cleaned up some styles for white mode hovering on search * Added missing genre search group, reworked some clearing code, fixed click handlers * Fixed genre property * Changed the series title to show bookmarks and the edit button will now take you to series * Fixed up accordion tabpanel color in dark mode * Fixed a typo of CoverArtist instead of "Cover artist" * Added some documentation changes * Fixed a bug where sort options on All-Series wasn't working * Added a thanks to Palace-Designs who hosts our infrastructure to the readme. * Fixed a bug where duplicate people for the same role would be returned * Fixed a bug where when user cleared out input manually, search would retain old search results
127 lines
6.1 KiB
Markdown
127 lines
6.1 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 manga,
|
|
and the goal of 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)
|
|
</div>
|
|
|
|
## Goals
|
|
- [x] Serve up Manga/Webtoons/Comics (cbr, cbz, zip/rar, 7zip, raw images) and Books (epub, pdf)
|
|
- [x] First class responsive readers that work great on any device (phone, tablet, desktop)
|
|
- [x] Dark and Light themes
|
|
- [ ] Provide hooks into metadata providers to fetch metadata for Comics, Manga, and Books
|
|
- [x] Metadata should allow for collections, want to read integration from 3rd party services, genres.
|
|
- [x] Ability to manage users, access, and ratings
|
|
- [ ] Ability to sync ratings and reviews to external services
|
|
- [x] Fully Accessible with active accessibility audits
|
|
- [x] Dedicated webtoon reading mode
|
|
- [ ] And so much [more...](https://github.com/Kareadita/Kavita/projects)
|
|
|
|
## 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
|
|
### Non-Docker
|
|
- Unzip the archive for your target OS
|
|
- Place in a directory that is writable. If on windows, do not place in Program Files
|
|
- Linux users must ensure the directory & kavita.db is writable by Kavita (might require starting server once)
|
|
- Run Kavita
|
|
- If you are updating, copy everything over into install location. All Kavita data is stored in config/, so nothing will be overwritten.
|
|
- Open localhost:5000 and setup your account and libraries in the UI.
|
|
### Docker
|
|
Running your Kavita server in docker is super easy! Barely an inconvenience. You can run it with this command:
|
|
|
|
```
|
|
docker run --name kavita -p 5000:5000 \
|
|
-v /your/manga/directory:/manga \
|
|
-v /kavita/data/directory:/kavita/config \
|
|
--restart unless-stopped \
|
|
-d kizaing/kavita:latest
|
|
```
|
|
|
|
You can also run it via the docker-compose file:
|
|
|
|
```
|
|
version: '3'
|
|
services:
|
|
kavita:
|
|
image: kizaing/kavita:latest
|
|
container_name: kavita
|
|
volumes:
|
|
- ./manga:/manga
|
|
- ./config:/kavita/config
|
|
ports:
|
|
- "5000:5000"
|
|
restart: unless-stopped
|
|
```
|
|
|
|
**Note: Kavita is under heavy development and is being updated all the time, so the tag for current 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.
|
|
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute. [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>
|
|
|
|
|
|
## 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.
|
|
|
|
## 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.
|
|
|
|
|
|
### License
|
|
|
|
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
|
* Copyright 2020-2022
|
|
|