diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 20 insertions, 12 deletions
@@ -1,19 +1,19 @@ -# swimmer +# Swimmer Network-based tile tool. -## installation +## Installation First, install miniconda and node. ``` conda create env -f environment.yml -npm install +yarn install ``` (this should work on Linux as well but let me know if it doesn't) -## running the site +## Running the site Before running the commands, enter the client directory, load the Conda environment, and make sure the database is current: @@ -26,19 +26,18 @@ conda activate swimmer Then build the frontend and run the Flask server: ``` -npm run build:dev -./cli.py flask run +yarn build:dev +yarn server ``` The server will be running on http://0.0.0.0:5000/ - -## development +## Development Monitor the Javascript for changes (run in another window): ``` -npm run watch +yarn watch ``` Generate a new migration if you've modified the database: @@ -48,10 +47,19 @@ Generate a new migration if you've modified the database: ./cli.py db upgrade head ``` -## building the site +Run the frontend demo flask server (port 3000): ``` -npm run build:production -./cli.py site export --graph swimmer +yarn demo ``` +To programmatically create pages, modify `cli/commands/site/populate.py` + +## Deploying a site + +A hypothetical rsync command: + +``` +cd data_store/exports/ +rsync -rlptuvz ./last-museum/ lens@garden:swimmer/data_store/exports/last-museum/ +``` |