diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | README.md | 21 | ||||
| -rw-r--r-- | backend/README.md | 3 | ||||
| -rw-r--r-- | backend/data/README.md | 2 | ||||
| -rw-r--r-- | package.json | 3 | ||||
| -rw-r--r-- | src/README.md | 17 |
6 files changed, 36 insertions, 12 deletions
@@ -1,4 +1,3 @@ -/rem.not /package-lock.json /node_modules/ /dist/ @@ -20,7 +19,6 @@ /backend/data/enwiki/*.bz2 /backend/data/enwiki/*.db /backend/data/enwiki/imgs/ -/backend/data/enwiki/.venv/ /backend/data/imgList.txt /backend/data/pickedImgs/ /backend/data/img/ @@ -1,5 +1,4 @@ -Grid of Life -============ +# Grid of Life An interactive visualisation of the biological tree of life. @@ -10,7 +9,17 @@ Each tile represents a group of organisms with a common ancestor. - Double-clicking on a tile expands it to fill the whole view. Other tiles will be moved to the side. -Files -===== -- backend/: Contains code for running the server, and generating tree-of-life data -- +# Files +- package.json: Contains project information, including what packages need to be installed. +- src: Contains most of the client-side code. +- index.html: Holds code for the main page, into which code from src/ will be included. +- backend: Contains code for running the server, and generating tree-of-life data +- public: Contains files to be copied unchanged when building for production. +- tailwind.config.js: For configuring Tailwind. +- postcss.config.js: For configuring Tailwind. +- tsconfig.json: For configuring Typescript. +- vite.config.js: For configuring Vite. +- .gitignore: Lists files to be ignored by Git. + +# Overview +# Instructions diff --git a/backend/README.md b/backend/README.md index 331e7f4..20263fd 100644 --- a/backend/README.md +++ b/backend/README.md @@ -1,4 +1,3 @@ -Files -===== +# Files - server.py: Runs the server - data/: For generating the server's tree-of-life database diff --git a/backend/data/README.md b/backend/data/README.md index f5b35f0..776ff17 100644 --- a/backend/data/README.md +++ b/backend/data/README.md @@ -1,6 +1,6 @@ This directory holds files used to generate data.db, which contains tree-of-life data. -# Tables: +# Tables ## Tree Structure data - `nodes` <br> Format : `name TEXT PRIMARY KEY, id TEXT UNIQUE, tips INT` <br> diff --git a/package.json b/package.json index 1f73d3c..f9c23ff 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,8 @@ "scripts": { "dev": "vite", "build": "vue-tsc --noEmit && vite build", - "preview": "vite preview" + "preview": "vite preview", + "tsc": "vue-tsc --noEmit" }, "author": "Terry Truong", "license": "MIT", diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..bccc3b1 --- /dev/null +++ b/src/README.md @@ -0,0 +1,17 @@ +# 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, and can include child nodes. + - AncestryBar.vue: Displays ancestors of the top-level Tile. + - TutorialPane.vue: Displays tutorial content. + - TileInfoModal.vue: Modal displaying info about a Tile's node. + - SearchModal.vue: Modal with a search bar. + - SettingsModal: Modal displaying configurable settings. + - HelpModal.vue: Modal displaying help info. + - RButton.vue: Basic button component. + - icon: Contains components that display SVG icons. +- layout.ts: Contains code for laying out Tiles. +- lib.ts: Contains classes/types and utility functions. +- index.css: Included by main.ts. Provides Tailwind's CSS classes. +- env.d.ts: From Vite's template files. |