From 436dd015471cbdea443cfd98536e55e683833c48 Mon Sep 17 00:00:00 2001 From: Terry Truong Date: Sun, 22 Jan 2023 11:32:28 +1100 Subject: Add deployment docs and script Add DEPLOY.md and prebuild.sh Update READMEs Change project name --- src/README.md | 19 +++++++++++++++++-- src/lib.ts | 2 +- 2 files changed, 18 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/README.md b/src/README.md index 409e796..5ef7892 100644 --- a/src/README.md +++ b/src/README.md @@ -2,6 +2,21 @@ - **main.ts**: Included by ../index.html. Creates the main Vue component. - **App.vue**: The main Vue component. - **components**: - - **TestComponent.vue**: For testing. -- **index.css**: Included by main.ts. Provides Tailwind's CSS classes. + - **TimeLine.vue**: Displays an interactive timeline. + - **BaseLine.vue**: Displays a timeline overview. + - **InfoModal.vue**: Modal displaying event info. + - **SearchModal.vue**: Modal providing a search bar. + - **SettingsModal.vue**: Modal displaying configurable settings. + - **HelpModal.vue**: Modal displaying help info. + - **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. +- **store.ts**: App global storage. +- **lib.ts**: Holds project-wide globals. +- **util.ts**: Holds utility functions. +- **rbtree.ts**: Red-black tree implementation. +- **index.css**: Included by main.ts. Provides Tailwind's CSS classes. - **vite-env.d.ts**: From Vite's template files. +- **global.d.ts**: Temporary typescript overrides. diff --git a/src/lib.ts b/src/lib.ts index 51bd2a4..051a449 100644 --- a/src/lib.ts +++ b/src/lib.ts @@ -1,5 +1,5 @@ /* - * Common project globals + * Project-wide globals */ import {moduloPositive, intToOrdinal, getNumTrailingZeros} from './util'; -- cgit v1.2.3