# 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 & 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.