diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 29 insertions, 18 deletions
@@ -1,21 +1,30 @@ -# Android myanimelist client project. (WIP) +# Aniki : Yet another android MyAnimeList client + +## F-Droid + +There is an on-going merge to put this app on the f-droid store. + +It's an installable catalogue of FOSS apps for android. + +The merge request : [https://gitlab.com/fdroid/fdroiddata/-/merge_requests/9027](https://gitlab.com/fdroid/fdroiddata/-/merge_requests/9027) ## Features -+ List of elements used in top manga and top anime with a recycler view ++ List of elements used in top manga and top anime with a recycler view. SwipeRefresh used to refresh the list of data of the first page. Use the button (prev and next) to navigate with ease through the pages. -<br/><br/> +<br/> + ++ Details of a chosen element from the recycler view with an intent object. -+ Details of a chosen element from the recycler view with an intent object +Title, synopsys and background selectable. -Title, synopsys and background clickable. URL link openable. -<br/><br/> +<br/> + Search pages for animes and mangas. @@ -25,7 +34,7 @@ A feature has been added that hides the keyboard when the query is submitted by We can also submit the query by clicking the "search" button that replace the "return" one. -Clicking on a searched item also opens a detail page of it. +Clicking on a searched item also opens a detailed page. I'm not adding the "multiple pages" feature to the search section because I assume the user should use a more precise query if what he's looking for doesn't show up in the first page. @@ -42,9 +51,9 @@ Usage of : + /v3/search/anime ## Data Storage -Data storage with sharedpreferences used for the recycler view of top manga and top anime as well as the details +Data storage with sharedpreferences used for the recycler view of top manga and top anime as well as the details. -Saves the detail page of an item when opened, not when the list is shown +Saves the detail page of an item when opened, not when the list is shown. Usage of ScrollView in the detail page. Thus, items with long synopsis and background aren't cut down. @@ -62,7 +71,8 @@ It consists of some colors of the pink/purple "family" : Also added the "bangers" font for the titles. ## Gitflow -Development done with a Gitflow workflow. I used master, release, develop and feature branches. +Development done with a Gitflow workflow. I used the master, release, develop and feature branches. +Later, I started to add tags. ## Architecture I used the MVC (Model, View, Controller) architecture. @@ -70,31 +80,32 @@ I used the MVC (Model, View, Controller) architecture. ## Singletons Usage of singletons. -Used to call APIs. +Used to call APIs and store the api url. ## Usage ### Swipe refresh -<img src="https://adjutor.xyz/gif/refresh-feature.gif" alt="swipe_refresh" width="300"/> +<img src="https://adjutor.xyz/gif/refresh-feature.gif" alt="swipe_refresh" width="350"/> ### Previous Displaying a snack when hitting the previously button on the first page : -<img src="https://adjutor.xyz/gif/prev-button-message.gif" alt="previous_button_on_first_page" width="300"/> +<img src="https://adjutor.xyz/gif/prev-button-message.gif" alt="previous_button_on_first_page" width="350"/> -This is a reminder since there's a bug (or a feature ;) ) that reset the page number inside the app/code but not the actual list displayed. +This is a reminder since there's a bug (or a feature ;) ) that resets the page number variable but not the actual list displayed. ### Next -<img src="https://adjutor.xyz/gif/next-button.gif" alt="next_button" width="300"/> +<img src="https://adjutor.xyz/gif/next-button.gif" alt="next_button" width="350"/> ### Text selection and openable link -<img src="https://adjutor.xyz/gif/text-selection-and-link.gif" alt="next_button" width="300"/> +<img src="https://adjutor.xyz/gif/text-selection-and-link.gif" alt="next_button" width="350"/> ### Search -<img src="https://adjutor.xyz/gif/search-feature.gif" alt="search_pages" width="300"/> +<img src="https://adjutor.xyz/gif/search-feature.gif" alt="search_pages" width="350"/> -## You Should Know Searching for an item using 2 or less characters will result in an API error. This error is normal, it comes from the REST API I'm using. + +<img src="https://adjutor.xyz/gif/search-error.gif" alt="search_error" width="350"/> |