-
-
Notifications
You must be signed in to change notification settings - Fork 364
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added some extra information and cleaned up goals.
- Loading branch information
1 parent
5ee27b5
commit 3a8ec47
Showing
1 changed file
with
6 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
# Kavita | ||
Kavita, meaning Stories, is a lightweight manga server. The goal is to replace Ubooqity with an | ||
open source variant that is flexible and packs more punch, without sacrificing ease to use. | ||
open source variant that is flexible and packs more punch, without sacrificing ease to use. | ||
|
||
## Goals: | ||
* Server up Comics (cbr, cbz, zip/rar, pdf, raw images) and Books (epub, mobi, azw, djvu, pdf) | ||
* Provide Reader for Comics and Books via web app that is responsive | ||
* Serve up Manga (cbr, cbz, zip/rar, raw images) and Books (epub, mobi, azw, djvu, pdf) | ||
* Provide Reader for Manga and Books (Light Novels) via web app that is responsive | ||
* Provide customization themes (server installed) for web app | ||
* Provide hooks into metadata providers to fetch Manga/Comic data | ||
* Provide hooks into metadata providers to fetch Manga data | ||
* Metadata should allow for collections, want to read integration from 3rd party services, genres. | ||
* Ability to manage users, access, and ratings | ||
* Expose an OPDS API/Stream for external readers to use | ||
* Allow downloading files directly from WebApp | ||
* WebApp/Server is Translated via Weblate (free for Open Source) | ||
|
||
|
||
## How to Deploy | ||
* Build kavita-webui via ng build --prod. The dest should be placed in the API/wwwroot directory | ||
* Run publish command | ||
* Run publish command |