summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJules Laplace <julescarbon@gmail.com>2021-03-15 19:09:37 +0100
committerJules Laplace <julescarbon@gmail.com>2021-03-15 19:09:37 +0100
commit8792e9fe1c7ab76c35f9a18d866880ba3da2c13e (patch)
treefbdc78484f654ec344d10814cb83987c873d4360 /README.md
parent7c15f34186622410e25ee85c01d832e48e012140 (diff)
move frontend site folder. add video support
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 9 insertions, 11 deletions
diff --git a/README.md b/README.md
index 0daf5db..dcfa219 100644
--- a/README.md
+++ b/README.md
@@ -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,9 @@ Generate a new migration if you've modified the database:
./cli.py db upgrade head
```
-## building the site
+## Building the site
```
npm run build:production
./cli.py site export --graph swimmer
```
-