Skip to content

Latest commit

 

History

History
139 lines (96 loc) · 4.7 KB

README.md

File metadata and controls

139 lines (96 loc) · 4.7 KB
Raw

Mr. Noodles Gallery App

This is Mr Noodles timeline app.

It connects to Mr Noodles API and displays media in galleries.

It's built with Solid JS app and Vite.

Features

Use cases

  • TODO (homescreen) type your name

  • TODO (homescreen) welcome back from thumbs

  • (timeline) list images grouped by day and folder

  • (timeline) navigate files with keyboard

  • (timeline) selects and deselects files, clears selection

  • (timeline) view file in modal

  • (timeline) navigate files in modal view

  • TODO (timeline) group by day/month/year

  • TODO (timeline) second group by folders/tag/none

  • TODO (timeline) select/deselect from within modal

  • TODO (timeline) show file details within modal (keyboard: D)

  • TODO (timeline) delete file (keyboard: DEL) requires modal dialog

  • TODO (timeline) start slideshow (keyboard: P)

  • TODO (timeline) item context menu (vertical "..." on top/right corner of item thumb & on full screen bar if no selection exists) with options: select/deselect; open preview; show details; delete

  • TODO (timeline) selection context menu (vertical "..." top/right corner of screen and modal when selection underway) with options: start slideshow; delete all

  • TODO (timeline) zoom in/out

  • (folders) list by parent

  • (folders) filter by text search

  • (folders) navigate with breadcrumbs and keyboard (Left, Right, ESC and BACKSPACE)

  • (folders) show files within selected folder

  • (folders) view file in modal

  • (folders) show folder thumb, title, and dates

  • TODO (folders) files selection context

  • TODO (folders) item context menu (vertical "..." on top/right corner of folder thumb) with options: select/deselect; open preview; show details; delete

  • TODO (timeline) selection context menu (vertical "..." top/right corner of screen and modal when selection underway) with options: start slideshow; delete all

  • TODO (delete) list deleted files

  • TODO (delete) restore deleted file

  • TODO (playlist) create playlist from folder (playlist.folders = [folder.id])

  • TODO (playlist) play playlist

  • TODO (playlist) show playlist icon in folder thumb/page (replay if exists)

  • TODO (playlist) list playlists

  • TODO (playlist) show playlist details

  • TODO (playlist) add folder to playlist

  • TODO (playlist) remove folder from playlist

  • TODO (playlist) share playlist

  • TODO (video) ingest files

  • TODO (video) handle video in lists with placeholder graphics only

  • TODO (video) video player in modal views

  • TODO (video) generate video thumbnails

  • TODO (video) generate video preview

  • TODO (timeline) filter files by date range

  • TODO (timeline) incremental load

  • TODO (timeline) list virtualization (fixed heights)

  • TODO (playlists) list playlists

  • TODO (playlists) delete playlist

  • TODO (playlists) edit playlist options

  • TODO (tags) add tag to file

  • TODO (tags) show file tags (toggle tag visibility from bar)

  • TODO (playlists) create playlist from tag

  • TODO (identicals) identify identical files

  • TODO (identicals) create group from identical files

  • TODO (blurs) identify blurry files

  • TODO (guestbook)

  • TODO (reminder)

  • TODO (shoppinglist)

  • TODO (settings) list locations (per owner)

  • TODO (settings) add/remove location

Technical

Capabilities

  • TODO display keyboard tooltips (accessible)
  • TODO turn keyboard tooltips on/off

Development

Read first: Mr Noodles README

Requirements

Dependencies

You have to build @noodlestan/shared-types first:

cd packages/shared/types
npm run build

Running the dev server

In watch mode

npm install
npm start

Troubleshooting

Build failures

Make sure you are running the prescribed node version

If the build fails with @noodlestan/shared-types errors, you might have pulled changes: rebuild packages/shared/types. Note: run that shared build in watch mode if you are actively changing those types. See shared/types/README.md for details.

Dev server fails to start

Check http://localhost:3000 for health

Is another instance running on same port? Stop it, or use a different port. See env for how.

Is the Mr Noodles API server running at http://localhost:8008/meta? Check packages/server/README.md for more info.

License

Copyright (c) 2023 Andre Torgal.

Published under a MIT License.