moved migrations out of dockerfile and updated documentation

Author: BigSpaceships

Dockerfile

@@ -35,7 +35,6 @@ ENV PORT=${PORT}
 EXPOSE ${PORT}
 
 COPY conditional /opt/conditional/conditional
-COPY migrations /opt/conditional/migrations
 COPY *.py package.json /opt/conditional
 COPY --from=build-frontend /opt/conditional/conditional/static /opt/conditional/conditional/static
 

README.md

@@ -8,72 +8,103 @@ A comprehensive membership evaluations solution for Computer Science House.
 Development
 -----------
 
-To run the application, you must have the latest version of [Python 3](https://www.python.org/downloads/) and [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) installed. Once you have those installed, create a new virtualenv and install the Python dependencies:
+### Config
+
+You must create `config.py` in the top-level directory with the appropriate credentials for the application to run. See `config.env.py` for an example.
 
+#### Add OIDC Config
+Reach out to an RTP to get OIDC credentials that will allow you to develop locally behind OIDC auth
+```py
+# OIDC Config
+OIDC_ISSUER = "https://sso.csh.rit.edu/auth/realms/csh"
+OIDC_CLIENT_CONFIG = {
+    'client_id': '',
+    'client_secret': '',
+    'post_logout_redirect_uris': ['http://0.0.0.0:6969/logout']
+}
 ```
+
+#### Database 
+You can either develop using the dev database, or use the local database provided in the docker compose file
+
+Using the local database is detailed below, but both options will require the dev database password, so you will have to ask an RTP for this too
+
+### Run (Without Docker)
+
+To run the application without using containers, you must have the latest version of [Python 3](https://www.python.org/downloads/) and [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) installed. Once you have those installed, create a new virtualenv and install the Python dependencies:
+
+```sh
 virtualenv .conditionalenv -p `which python3`
 source .conditionalenv/bin/activate
 pip install -r requirements.txt
-export FLASK_APP=app.py
 ```
 
-In addition, you must have Node, NPM, and Gulp CLI installed to properly execute the asset pipeline. If you don't have Node installed, we recommending installing with [NVM](https://github.com/creationix/nvm):
+In addition, you must have Node, NPM, and Weback CLI installed to properly execute the asset pipeline. If you don't have Node installed, we recommending installing with [NVM](https://github.com/creationix/nvm):
 
-```
+```sh
 nvm install
 nvm use
-npm install -g gulp
+npm install -g webpack
 ```
 
-Then, install the pipeline and frontend dependencies:
+Then, install the pipeline and frontend dependencies: (do this in the `frontend` directory)
 
-```
+```sh
 npm install
 ```
 
-### Config
+Once you have all of the dependencies installed, run
 
-You must create `config.py` in the top-level directory with the appropriate credentials for the application to run. See `config.sample.py` for an example.
+```sh
+npm webpack
+```
 
-#### Add OIDC Config
-Reach out to an RTP to get OIDC credentials that will allow you to develop locally behind OIDC auth
+This will build the frontend assets and put them in the correct place for use with flask
+
+Finally, start the flask app with `gunicorn`
+
+```sh
+gunicorn
 ```
-# OIDC Config
-OIDC_ISSUER = "https://sso.csh.rit.edu/auth/realms/csh"
-OIDC_CLIENT_CONFIG = {
-    'client_id': '',
-    'client_secret': '',
-    'post_logout_redirect_uris': ['http://0.0.0.0:6969/logout']
-}
+
+or 
+
+```sh
+python -m gunicorn
 ```
 
-### Run
+### Run (containerized)
 
-Once you have all of the dependencies installed, simply run:
+It is likely easier to use containers like `podman` or `docker` or the corresponding compose file
 
-```
-npm start
+With podman, I have been using 
+
+```sh
+podman compose up --force-recreate --build
 ```
 
-This will run the asset pipeline, start the Python server, and start BrowserSync. Your default web browser will open automatically. If it doesn't, navigate to `http://127.0.0.1:3000`. Any changes made to the frontend files in `frontend` or the Jinja templates in `conditional/templates` will cause the browser to reload automatically.
+Which can be restarted every time changes are made
 
 ### Dependencies
 
 To add new dependencies, add them to `requirements.in` and then run `pip-compile requirements.in` to produce a new locked `requirements.txt`. Do not edit `requirements.txt` directly as it will be overwritten by future PRs.
 
 ### Local database
 
-You can run the database locally using the docker compose, make sure to upgrade it as explained below
+You can run the database locally using the docker compose
 
 To populate it with dev data for example, you can use the command
 
-```
-PGPASSWORD='[DB PASSWORD]' pg_dump -h postgres.csh.rit.edu -p 5432 -U conditional-dev conditional-dev |  PGPASSWORD='fancypantspassword' psql -h localhost -p 5432 -U conditional conditional
+```sh
+PGPASSWORD='[DB PASSWORD]' pg_dump -h postgres.csh.rit.edu -p 5432 -U conditionaldev conditionaldev |  PGPASSWORD='fancypantspassword' psql -h localhost -p 5432 -U conditional conditional
 ```
 
 This can be helpful for changing the database schema
 
-NOTE: to use flask db commands with a database running in the compose file, you will have to update your url to point to localhost, not conditional-postgres
+To run migration commands in the local database, you can run the commands inside the docker container. Any migrations created will also be in the local repository since migrations are mounted in the docker compose
+```sh
+podman exec conditional flask db upgrade
+```
 
 ### Database Migrations
 

docker-compose.yaml

@@ -7,6 +7,8 @@ services:
       - conditional-postgres
     ports:
       - "127.0.0.1:8080:8080"
+    volumes:
+      - ./migrations:/opt/conditional/migrations
   conditional-postgres:
     image: docker.io/postgres
     container_name: conditional-postgres