From 3bf200cb4339e906b944d55451cfacc8aa33bb01 Mon Sep 17 00:00:00 2001 From: Jules Laplace Date: Tue, 7 Sep 2021 17:16:38 +0200 Subject: comment everything and add notes on working on the last museum --- README.md | 44 ++++++++++++++++++-------------------------- 1 file changed, 18 insertions(+), 26 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index fde266b..c16cfe5 100644 --- a/README.md +++ b/README.md @@ -13,30 +13,12 @@ yarn install (this should work on Linux as well but let me know if it doesn't) -## Running the site - -Before running the commands, enter the client directory, load the Conda environment, and make sure the database is current: - -``` -cd cli -conda activate swimmer -./cli.py db upgrade head -``` - -Then build the frontend and run the Flask server: - -``` -yarn build:dev -yarn server -``` - -The server will be running on http://0.0.0.0:5000/ - ## Development Monitor the Javascript for changes (run in another window): ``` +nvm use v12 yarn watch ``` @@ -55,18 +37,28 @@ yarn demo To programmatically create pages, modify `cli/commands/site/populate.py` -## Customizing builds +## Running the site -If the functionality of the live site needs to change, make a new router and go from there. See `frontend/site/projects/museum/app.js` for an example. +Before running the commands, enter the client directory, load the Conda environment, and make sure the database is current: ``` -# Building the Last Museum site (development) -yarn build:museum:dev +cd cli +conda activate swimmer +./cli.py db upgrade head +``` + +Then build the frontend and run the Flask server: -# Deploying the Last Museum site (production) -yarn build:museum:production -rsync -rlptuvz ./data_store/exports/thelastmuseum/ lens@garden:swimmer/data_store/exports/thelastmuseum/ ``` +yarn build:dev +yarn server +``` + +The server will be running on http://0.0.0.0:5000/ + +## Customizing builds + +If the functionality of the live site needs to change, make a new router and go from there. See `frontend/site/projects/museum/app.js` for an example. To customize the built site HTML, create files in `data_store/content/{graph_path}`: -- cgit v1.2.3-70-g09d2