From f4273ebfd6c28820dde362bfa79910aa69096fee Mon Sep 17 00:00:00 2001 From: Evan Reichard Date: Sun, 21 Feb 2021 22:52:18 -0500 Subject: [PATCH] Update README --- README.md | 37 ++++++++++++++++++++----------------- web_native/README.md | 14 ++++++++++++++ 2 files changed, 34 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 04ea071..912934c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,29 @@ # Imagini A self hosted photo library with user management & authentication. Cross platform Client supporting Android, iOS, and Web. +## Client +See `web_native` [subfolder](./web_native/README.md) + ## Server +### Features / Roadmap +- [DONE] DB w/ user management - bcrypt salt & hash +- [DONE] JWT Access & Refresh Tokens +- [DONE] GraphQL API +- [DONE] GraphQL multipart upload +- [DONE] GraphQL basic filtering, ordering, pagination +- [DONE] Uploading images - exif extraction (load db with lat, long, etc) +- [DONE] Dynamic image conversion (heif support, width params) + +- [TODO] ALL the tests +- [TODO] GraphQL & DB deletes & update +- [TODO] Dockerfile +- [TODO] Resolving GraphQL nested queries (e.g. albums, tags) +- [TODO] GraphQL nested filters +- [TODO] Lots more... TBD + ### Dependencies -- libvips 8.3+ (8.8+ recommended) +- libvips 8.8+ ### Running @@ -18,19 +37,3 @@ A self hosted photo library with user management & authentication. Cross platfor # Generate GraphQL Documentation graphdoc -e http://localhost:8484/query -o ./docs/schema - -## Client -See `web_native` subfolder. -### Running - - # Chrome - flutter run -d chrome - - # Simulator - open -a Simulator - flutter run - -### Building - - # Generate GraphQL Flutter Models - flutter pub run build_runner build diff --git a/web_native/README.md b/web_native/README.md index 6d867ab..22d7b2b 100644 --- a/web_native/README.md +++ b/web_native/README.md @@ -1,6 +1,20 @@ # Imagini Client A cross platform (iOS, Android, & Web) client used with the Imagini server. +## Features / Roadmap +- [DONE] Login w/ errors +- [DONE] GraphQL client +- [DONE] Load & tile images for user +- [DONE] Access & Refresh Token secure storage (`localStorage` web -_-) + +- [TODO] ALL the tests +- [TODO] Pagination and lazy scroll load +- [TODO] File picker upload +- [TODO] Sync upload (Android & iOS) +- [TODO] Image caching (Android & iOS) +- [TODO] Lots more... TBD + + ## Running # Chrome