diff --git a/README.md b/README.md index 6218819..e78785b 100644 --- a/README.md +++ b/README.md @@ -53,8 +53,6 @@ docker run -it --init \ ### Docker compose ```yaml -version: '3.8' - name: reiverr services: @@ -172,3 +170,13 @@ If you'd like to develop your own plugin, easiest way to get started is by getti ![Series Page](images/screenshot-2.png) ![Library Page](images/screenshot-3.png) + +# Star History + + + + + + Star History Chart + + diff --git a/frontend/README.md b/frontend/README.md new file mode 100644 index 0000000..df12476 --- /dev/null +++ b/frontend/README.md @@ -0,0 +1,46 @@ +# Frontend + +Here you can find an overview of the most important internal components and practices that are used in the frontend. + +## Important Components + + + +[src/lib/components/**Container.svelte**](src/lib/components/Container.svelte) + +A component that can be navigated to with dpad/keyboard, backbone of the dpad navigation system. + +## Important Contexts and Stores + +[src/lib/components/StackRouter/**stack-router.store.ts**](src/lib/components/StackRouter/stack-router.store.ts) + +Provides access to the stack router, which is used for client side navigation and routing, as well as passing context between stack pages. Important functions: + +- useComponentStack: provides access to the stack router component stack +- navigate: navigate to a url +- getContext, setContext, hasContext: custom context implementation, is used the same as svelte's context + +--- + +[src/lib/stores/**data**/](src/lib/stores/data/) + +Data fetching stores and utilities. + +--- + +[src/lib/components/GlobalBackground/**background-stack.store.ts**](src/lib/components/GlobalBackground/background-stack.store.ts) + +Provides access to the global background stack, which allows reusing backgrounds between pages. + + + +## Notes & Tips + +**backface-visibility: hidden**: Add to scroll containers to fix repaint issues on old browsers. + + diff --git a/frontend/src/lib/components/StackRouter/stack-router.store.ts b/frontend/src/lib/components/StackRouter/stack-router.store.ts index 265c78a..2982aa1 100644 --- a/frontend/src/lib/components/StackRouter/stack-router.store.ts +++ b/frontend/src/lib/components/StackRouter/stack-router.store.ts @@ -198,7 +198,7 @@ type HistoryState = { export type StackRouterStore = ReturnType; -export function useStackRouter({ +function useStackRouter({ routes, notFound, maxDepth