From 94a8ad9b067e5a2c442ce47ce72d1a53eb444160 Mon Sep 17 00:00:00 2001 From: Terry Truong Date: Mon, 23 Jan 2023 18:00:43 +1100 Subject: Clean up some docs and naming inconsistencies --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7245274..e63ce01 100644 --- a/README.md +++ b/README.md @@ -38,15 +38,14 @@ stored using [Sqlite](https://www.sqlite.org). ## Setup Instructions Note: Running your own version of the client and server should be straightforward, -but generating the database that they use takes a long time. More details are -in `backend/tolData/README.md`. +but generating the database takes a long time. More details are +in `backend/tol_data/README.md`. ### Client Side 1. If you don't have npm or Node.js installed, you can download a Node installer from , which includes npm. This project was coded using version 16. 1. In this directory, run the command `npm install`, which install packages listed in package.json, creating a `node_modules` directory to hold them. -1. Running `npm run dev` starts the dev server. ### Server Side 1. If you don't have Python 3 installed, see . @@ -54,9 +53,8 @@ in `backend/tolData/README.md`. 1. The database used by the server is generated using scripts in `backend/tol_data/`. See it's README for instructions. You'll likely need to install a few packages using Pip. -1. The dev server is started by running `./server.py` in the `backend/` directory. - To run it, you'll need to install jsonpickle. This can be done using - `python -m pip install jsonpickle`. +1. To run the data server via `backend/server.py`, you'll need to install jsonpickle. + This can be done using `python -m pip install jsonpickle`. If you want to keep the installed package separate from your system's packages, it's common practice to use [venv](https://docs.python.org/3/tutorial/venv.html). -- cgit v1.2.3