Update README

This commit is contained in:
Evan Reichard 2021-02-21 22:52:18 -05:00
parent f46db58ed1
commit f4273ebfd6
2 changed files with 34 additions and 17 deletions

View File

@ -1,10 +1,29 @@
# Imagini # Imagini
A self hosted photo library with user management & authentication. Cross platform Client supporting Android, iOS, and Web. 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 ## 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 ### Dependencies
- libvips 8.3+ (8.8+ recommended) - libvips 8.8+
### Running ### Running
@ -18,19 +37,3 @@ A self hosted photo library with user management & authentication. Cross platfor
# Generate GraphQL Documentation # Generate GraphQL Documentation
graphdoc -e http://localhost:8484/query -o ./docs/schema 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

View File

@ -1,6 +1,20 @@
# Imagini Client # Imagini Client
A cross platform (iOS, Android, & Web) client used with the Imagini server. 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 ## Running
# Chrome # Chrome