aboutsummaryrefslogtreecommitdiff
path: root/src/README.md
diff options
context:
space:
mode:
authorTerry Truong <terry06890@gmail.com>2022-07-11 15:03:32 +1000
committerTerry Truong <terry06890@gmail.com>2022-07-11 15:09:56 +1000
commit776692bc0a5115202774b715bd14d2cd505549dc (patch)
treebb81866cddae09b57e648d83b74269d89cabead5 /src/README.md
parente77845075eaa813b5c8bf765023e0423f4327780 (diff)
Use initial-tree-cache to reduce initial load timeinitial-tree-cache
Diffstat (limited to 'src/README.md')
-rw-r--r--src/README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/src/README.md b/src/README.md
index 5c88b2e..cc10e08 100644
--- a/src/README.md
+++ b/src/README.md
@@ -14,9 +14,16 @@
- **IconButton.vue**: Simple button component containing an SVG icon.
- **SCollapsible.vue**: Simple collapsible-content component.
- **icon**: Contains components that display SVG icons.
-- **tol.ts**: Holds types for tree-of-life data.
-- **layout.ts**: Holds code for laying out tiles.
-- **lib.ts**: Holds project-wide globals.
-- **util.ts**: Holds utility functions.
-- **index.css**: Included by main.ts. Provides Tailwind's CSS classes.
-- **env.d.ts**: From Vite's template files.
+- **tol.ts**: Holds types for tree-of-life data.
+- **layout.ts**: Holds code for laying out tiles.
+- **lib.ts**: Holds project-wide globals.
+- **util.ts**: Holds utility functions.
+- **index.css**: Included by main.ts. Provides Tailwind's CSS classes.
+- **initialTrees.json**: Cache of initial tree data from server. Used to reduce load time.
+
+ Holds a map from tree names (trimmed, images, picked) to the result of querying the
+ backend dev server at `http://localhost:8000/data/?type=node&tree=TREE_NAME`.
+
+ Usage can be disabled by replacing `import initialTrees from ...;` in App.vue with
+ `const initialTrees = null;`.
+- **env.d.ts**: From Vite's template files.