adding web app base

1 files changed, 47 insertions, 0 deletions

diff --git a/animism-align/README.md b/animism-align/README.md
new file mode 100644
index 0000000..e08c35a
--- /dev/null
+++ b/animism-align/README.md
@@ -0,0 +1,47 @@
+# animism-align
+
+Align a text to an audio file.
+
+## installation
+
+First, install miniconda and node.
+
+```
+conda create env -f environment.yml
+npm install
+```
+
+## 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 animism
+./cli.py db upgrade head
+```
+
+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'
+./cli.py db upgrade head
+```