aboutsummaryrefslogtreecommitdiff
path: root/src/README.md
blob: cc10e0825f0527054cd842d6f263f28666f5a24d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Files
-   **main.ts**: Included by ../index.html. Creates the main Vue component.
-   **App.vue**: The main Vue component.
-   **components**:
    -   **Tile.vue**:          Displays a tree-of-life node.
    -   **TileInfoModal.vue**: Modal displaying info about a Tile's node.
    -   **SearchModal.vue**:   Modal providing a search bar.
    -   **SettingsModal**:     Modal displaying configurable settings.
    -   **HelpModal.vue**:     Modal displaying help info.
    -   **AncestryBar.vue**:   Displays ancestors of the outermost Tile.
    -   **TutorialPane.vue**:  Displays tutorial content.
    -   **LoadingModal.vue**:  Displays a loading indicator.
    -   **SButton.vue**:       Simple button component.
    -   **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.
-   **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.