diff options
| author | Clyhtsuriva <aimeric@adjutor.xyz> | 2021-04-13 13:22:04 +0200 |
|---|---|---|
| committer | Clyhtsuriva <aimeric@adjutor.xyz> | 2021-04-13 13:22:04 +0200 |
| commit | 5a8c22508e08b00a31c8ebb4df13d9e108d29e1f (patch) | |
| tree | 432a7b67aebba75725e7fc9fe13cf09ae1ea0071 /README.md | |
| parent | c7720c2c8dce929e72bc2cea23ff7390a1da3296 (diff) | |
Restructuring and README update.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 23 insertions, 2 deletions
@@ -1,5 +1,9 @@ +# Android myanimelist client project. (WIP) + +## Features + List of elements used in top manga and top anime with a recycler view -SwipeRefresh used to refresh the list of data of the frist page. +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. Details of a chosen element from the recycler view with an intent object @@ -13,6 +17,7 @@ We can also submit the query by clicking the "search" button that replace the "r Clicking on a searched item also opens a detail page of it. 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. +## API Multiple calls of the REST API from jikan.moe. Usage of : + /v3/top/manga @@ -22,10 +27,12 @@ Usage of : + /v3/search/manga + /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 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. +## Design Used my "personal" theme colors for the app. It consists of some colors of the pink/purple "family" : + very dark purple : #09022A @@ -34,4 +41,18 @@ It consists of some colors of the pink/purple "family" : + slightly desaturated magenta : #C583B6 + grayish magenta : #C9A6C9 -Development done with a Gitflow workflow. +Also added the "bangers" font for the titles. + +## Gitflow +Development done with a Gitflow workflow. I used master, release, develop and feature branches. + +## Architecture +I used the MVC architecture. + +## TO-DO ++ Finishing MVC ++ Adding Singleton ++ Clicking on an image opens it full size ++ Firebase ++ Bottom navigation ++ ... |