aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTerry Truong <terry06890@gmail.com>2022-10-07 12:37:48 +1100
committerTerry Truong <terry06890@gmail.com>2022-10-07 12:37:48 +1100
commit1c69c4abf6e54ccab886c23cd6e691179ce6f076 (patch)
treedfc4652254184d17ec05ead55bdc5ee5c04376bc /README.md
parent141f310d87f4fd7c3a4c728bf278c10fadc19606 (diff)
Install client side tools
Install and configure Vite, Vue, Tailwind, Pinia, Typescript, and ESLint Add basic framework files (index.html, App.vue, main.ts, etc) Update READMEs Add favicon, font, and LICENCE.txt
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3d98947
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# Histplorer
+
+An interactive historical timeline.
+[Available online](https://terryt.dev/tilo/).
+
+## Project Overview
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.
+
+## Files
+
+### Project Level
+- **package.json**: Contains npm project information, such as package dependencies
+- **package-lock.json**: Auto-generated by npm. Used for replicable installations
+- **LICENCE.txt**: This project's license (MIT)
+### Client &amp; Server
+- **src**: Contains most of the client-side code
+- **index.html**: Holds code for the main page, into which code from 'src' will be included
+- **public**: Contains files to be copied unchanged in the client's production build
+- **backend**: Contains code for the server, and for generating history data
+### Configuration
+- **vite.config.js**: For configuring Vite
+- **tailwind.config.js**: For configuring Tailwind
+- **postcss.config.js**: For configuring Tailwind
+- **tsconfig.json**: For configuring Typescript
+- **tsconfig.node.json**: For configuring Typescript
+### Other
+- **.gitignore**: Lists files to be ignored if using Git
+
+## Setup Instructions
+
+### Client Side
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.
+
+### Server Side
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.
+
+### Running Histplorer
+1. In `backend/`, run `./server.py`, which starts a basic HTTP server that provides
+ history data on port 8000.
+1. Running `npm run dev` starts the dev server.
+1. Open a web browser, and navigate to <http://localhost:5713>.
+
+## Deploying the Website
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.
+
+## Licence
+
+Histplorer is licensed under the MIT Licence.