initial site copied in

1 files changed, 53 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e6d5690
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# swimmer
+
+Network-based tile tool.
+
+## installation
+
+First, install miniconda and node.
+
+```
+conda create env -f environment.yml
+npm install
+```
+
+(this should work on Linux as well but let me know if it doesn't)
+
+Set up the database:
+
+```
+./cli.py db upgrade head
+```
+
+## running the site
+
+Before running the commands, enter the client directory and load the Conda environment:
+
+```
+cd cli
+conda activate swimmer
+```
+
+Then build the frontend and run the Flask server:
+
+```
+npm run build
+./cli.py flask run
+```
+
+The server will be running on http://0.0.0.0:5000/
+
+
+## development
+
+Monitor the Javascript for changes (run in another window):
+
+```
+npm run watch
+```
+
+Generate a new migration if you've modified the database:
+
+```
+./cli.py db revision --autogenerate -m 'describe the changes'
+```