KawAnime/README.md

159 lines
3.4 KiB
Markdown
Raw Normal View History

<h1 align="center">KawAnime</h1>
<p align="center">
<a href="http://forthebadge.com/">
<img src="http://forthebadge.com/images/badges/built-with-love.svg"/>
</a>
</p>
<p align="center">
<a href="https://standardjs.com/">
<img src="https://cdn.rawgit.com/feross/standard/master/badge.svg" />
</a>
</p>
<p align="center">
<a href="https://travis-ci.org/Kylart/KawAnime">
<img src="https://travis-ci.org/Kylart/KawAnime.svg?branch=master" alt="Build Status">
</a>
<a href="https://codecov.io/gh/Kylart/KawAnime">
<img src="https://codecov.io/gh/Kylart/KawAnime/branch/master/graph/badge.svg" alt="Codecov" />
</a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
</a>
</p>
# Features
Disclaimer : This is a software for otaku/anime-fans. Do not try if you're not prepared.
This software allows one to:
* Be aware of the latest anime release.
2017-04-15 14:16:14 +00:00
* Download an anime (from ep X to ep Y) via Torrent (one would need a torrent client atm). One can also only get a
list of torrent magnets to paste in a torrent client on a distant server.
2017-07-26 21:55:52 +00:00
* Get information from any anime (those come from myanimelist.net).
2016-12-10 15:27:06 +00:00
* Get anime-related news from MyAnimeList.net.
* Get seasonal releases information (from [www.livechart.me](https://www.livechart.me)).
* Manage your anime files (watch and delete on click)
2017-04-15 14:16:14 +00:00
* Manage watch lists.
2017-07-26 21:55:52 +00:00
* Browse nyaa (si and pantsu).
* More features are to come.
2016-11-27 09:49:17 +00:00
## About OS
_KawAnime_ is completely cross-platform.
2017-02-07 10:19:29 +00:00
Yet, if you find any problem, you can tell me anytime in the `issues` section.
2016-11-27 09:49:17 +00:00
2016-11-21 14:33:22 +00:00
## Installation
Be sure that you have Npm installed. You can find how to install npm (node) [here](https://nodejs.org/en/).
2016-11-21 14:33:22 +00:00
```
2016-11-21 14:37:04 +00:00
git clone https://github.com/Kylart/KawAnime
2016-11-21 14:33:22 +00:00
```
```
2016-11-21 14:37:04 +00:00
cd KawAnime/
2016-11-21 14:33:22 +00:00
```
```
npm install
2016-11-21 14:33:22 +00:00
```
2016-12-10 15:27:06 +00:00
## Start
```
npm run build && npm start
```
Or
```
npm run bstart
2016-12-10 15:27:06 +00:00
```
2017-04-15 14:16:14 +00:00
## Run in dev
##### Start all app
2017-04-15 14:16:14 +00:00
```
npm run dev
```
#### Start only server with hot reloading
_using this with a REST api client is kinda useful_.
```
npm run dev:server
```
##### 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).
You can 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 buildAll
```
#### For Mac OS only
```
npm run build && npm run buildMac
```
#### For Linux platforms only
```
npm run build && npm run buildLinux
```
#### For Windows platforms
```
npm run build && npm run buildWin
```
Distributable will then be in the `dist` folder.
2016-12-10 15:27:06 +00:00
2016-11-21 14:33:22 +00:00
## Contributing
Any contribution is appreciated.
2016-11-21 14:33:22 +00:00
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.
## TODOs
2017-04-15 14:16:14 +00:00
* Implement torrents with WebTorrent module.
## Thanks
This software is being developped with the following technologies, many thanks to
2017-04-15 14:16:14 +00:00
* [Electron](https://electron.atom.io)
* [Vuetify](https://vuetifyjs.com)
2016-11-21 14:33:22 +00:00
_It is still in development_.
2016-11-21 14:33:22 +00:00
## License
MIT License
Copyright (c) Kylart