aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTerry Truong <terry06890@gmail.com>2022-07-11 19:39:40 +1000
committerTerry Truong <terry06890@gmail.com>2022-07-11 19:47:27 +1000
commitb06b3a9cb3ae772202f522ae085446a040736c95 (patch)
treefbef7b959cde94b786cbb0d68935944f9928852e /README.md
parent819edfe38fb0f130f1a2df0593c8798160b67022 (diff)
Add deployment documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index ebda699..5221183 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,6 @@ stored using [Sqlite](https://www.sqlite.org).
- **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).
-- **.gitignore**: Lists files to be ignored if using [Git](https://git-scm.com/downloads).
### 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.
@@ -30,6 +29,10 @@ stored using [Sqlite](https://www.sqlite.org).
- **tailwind.config.js**: For configuring Tailwind.
- **postcss.config.js**: For configuring Tailwind.
- **tsconfig.json**: For configuring Typescript.
+### Other
+- **.gitignore**: Lists files to be ignored if using [Git](https://git-scm.com/downloads).
+- **DEPLOY.md**: Instructions for deployment on an Apache server on Ubuntu.
+- **prebuild.sh**: Bash script for automating some steps of deployment.
## Setup Instructions
@@ -46,8 +49,8 @@ in backend/data/README.md.
### Server Side
1. If you don't have Python 3 installed, see <https://www.python.org/downloads>.
The package manager Pip is included.
-1. The database used by the server is generated using scripts in backend/data/.
- See it's README.md for instructions. You'll likely need to install a few
+1. The database used by the server is generated using scripts in `backend/data/`.
+ See it's README for instructions. You'll likely need to install a few
packages using Pip.
1. To run the dev server, you'll need to install jsonpickle. This can be done
using `python -m pip install jsonpickle`. If you want to keep the installed
@@ -55,12 +58,16 @@ in backend/data/README.md.
the 'venv' module.
### Running Tilo
-1. In the backend/ directory, run `./server.py`, which starts a basic HTTP server that provides
+1. In `backend/`, run `./server.py`, which starts a basic HTTP server that provides
tree-of-life data on port 8000.
-1. In this directory, or somewhere in src/, run `npm run dev`. This starts a dev server that
+1. In this directory, or somewhere in `src/`, run `npm run dev`. This starts a dev server that
provides Tilo's user interface on port 3000.
1. Open a web browser, and navigate to <http://localhost:3000>.
+## Deploying the Website
+This is significantly dependent on the server platform. `DEPLOY.md` contains
+instructions for deployment on an Apache server on an Ubuntu system.
+
## Licence
-Tilo is licensed under the MIT licence, provided in LICENSE.txt
+Tilo is licensed under the MIT licence, provided in `LICENSE.txt`