KawAnime

Build Status Codecov License Chat

# Features Disclaimer : KawAnime is built for otaku/anime-fans. Software will contain images and sounds sourced from anime. Do not try if you're not prepared. Use KawAnime to: * Get updated on anime releases. * Download episodes of an anime (from ep X to ep Y) via Torrent (requires Torrent Client). * Magnet links for all episodes can be generated through the Downloader. * Get anime information, news, and seasonal information (information sourced from MyAnimeList.net) * Manage your anime files (watch and delete on click) * Manage watch lists. * More features to come. ## 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](https://nodejs.org/en/). ``` git clone https://github.com/Kylart/KawAnime ``` ``` cd KawAnime/ ``` ``` npm install ``` ## Start ``` npm run build && npm start ``` Or ``` npm run bstart ``` ## Run in dev ##### Start all app ``` npm run dev ``` ##### Lint ``` npm run lint ``` #### Testing ##### Server ``` npm run test:server ``` ##### Front ``` npm run test:front ``` ##### Full tests ``` npm run test ``` ##### To know the number of line of code ``` npm run cloc ``` ## Generating distributable apps This feature uses [electron-builder](https://github.com/electron-userland/electron-builder). Find help to use it on your platform [here](https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build). #### For every OS ``` npm run build && npm run dist:all ``` #### For Mac OS only ``` npm run build && npm run dist:mac ``` #### For Linux OS only ``` npm run build && npm run dist:linux ``` #### For Windows OS only ``` npm run build && 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 * [Electron](https://electron.atom.io) and * [Vuetify](https://vuetifyjs.com) _It is still in development_. ## License MIT License Copyright (c) Kylart