Kylart / Anikki

The ultimate anime companion
MIT License
74 stars 5 forks source link
anime companion desktop download mobile streaming

Anikki

Anikki is currently being developped as a hobby of mine and many things are subject to change.

Features

Building

  1. Install Flutter for you platform
  2. Clone this repo
git clone --recursive https://github.com/Kylart/Anikki

cd Anikki
cp .env.example .env

flutter build <platform>

Develop

flutter run

To re-generate Anilist schema and classes

You will need nodejs installed.

# Generate Anilist types
cd scripts
npm install && npm run gen:schema

cd ..
dart run build_runner build

# (Optional) If you want to work on the Anilist types
dart run build_runner watch

Run tests

Unit tests

flutter test

Integration tests

Very limited for now

flutter test integration_test

Architecture

This project is implementing the architecture described by the BloC library for now.

Contributing

Any contribution is appreciated.

What to do

You can see what are the next things on the roadmap on this Trello board.

Feel free to contact me on Discord if you need any details on the implementation!

How to

  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.

License

MIT License

Copyright © 2022 & onwards, Kylart kylart.dev@gmail.com

Credits

App icon by Freepik

Disclaimer

Anikki is designed solely for providing access to publicly available content. It is not intended to support or promote piracy or copyright infringement. As the creator of this app, I hereby declare that I am not responsible for, and in no way associated with, any external links or the content they direct to.

It is essential to understand that all the content available through this app are found freely accessible on the internet and the app does not host any copyrighted content. I do not exercise control over the nature, content, or availability of the websites linked within the app.

If you have any concerns or objections regarding the content provided by this app, please contact the respective website owners, webmasters, or hosting providers. Thank you.