Kylart
/
KawAnime
mirror of https://github.com/Kylart/KawAnime.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
KawAnime/README.md

3.7 KiB
Raw Blame History

KawAnime

License Chat

Features

Disclaimer : KawAnime is built for otaku/anime-fans. The software will contain images and sounds sourced from anime. Do not try if you're not prepared.

Use KawAnime to:

  • Manage your pirate anime life with a single software.
  • Get updated on anime releases as soon as they are subbed (or not).
  • Download or Stream your torrents easily (in-app torrent client included!).
  • Magnet links for all episodes can be generated through the Downloader.
  • Get anime information, news, and seasonal information from your preferred anime information source (Anilist, Kitsu.io, MAL).
  • Manage your anime files (watch and delete on click).
  • Manage local watch lists as well as those from your preferred provider (Anilist, Kitsu.io, MAL).
  • Auto track entry progress on Anilist and Kitsu.io.
  • Keep track of what you watched with the History.
  • Easily binge watch your local anime or while streaming.

Feel free to check the official website for a demo of all the available features.

About OS

KawAnime is completely cross-platform.

If you have any problems installing for your OS, you can contact me anytime in the issues section.

Installation

Be sure that Npm is installed. You can find how to install npm (node) here.

git clone https://github.com/Kylart/KawAnime

cd KawAnime/

npm install

Run in dev

Start app
npm run dev
Lint
npm run lint

Testing

Testing is not implemented yet as it takes time :(

Two types are setup though:

  1. e2e with Cypress (see tests/e2e)
  2. Unit tests (see tests/unit)

Generating distributable apps

This feature uses electron-builder.

Find help to use it on your platform here.

For every OS

npm run dist

For Mac OS only

npm run dist:mac

For Linux OS only

npm run dist:linux

For Windows OS only

npm run dist:win

Distributable will then be in the dist folder.

Contributing

Any contribution is appreciated.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

Thanks

KawAnime is developed using the following technologies, many thanks to

License

MIT License

Copyright (c) Kylart