Add development run script and instructions

README.MD

@@ -1,13 +1,13 @@
 # CTP Slack Bot
 
+## Tech Stack
 
-## Dependencies
-
-* Python 3.12
-
-### Development-specific
-
-* Docker
+* Hugging Face Spaces for hosting and serverless API
+* Google Drive for reference data (i.e., the material to be incorporated into the bot’s knowledge base)
+* MongoDB for data persistence
+* Docker for containerization
+* Python
+    * See `pyproject.toml` for Python packages.
 
 ## General Project Structure
 
@@ -24,3 +24,34 @@
 * `tests/`: unit tests
 * `scripts/`: utility scripts for development, deployment, etc.
 * `notebooks/`: Jupyter notebooks for exploration and model development
+
+## How to Run the Application
+
+### Normally
+
+Just run the Docker image. 😉
+
+### For Development
+
+Development usually requires rapid iteration. That means a change in the code ought to be reflected as soon as possible in the behavior of the application.
+
+First, make sure you are set up with a Python virtual environment created by the Python `venv` module and that it’s activated. Then install dependencies from `pyproject.toml` within the environment using:
+
+```sh
+pip3 install -e .
+```
+
+If `localhost` port `8000` is free, running the following will make the application available on that port:
+
+```sh
+scripts/run-dev.sh
+```
+
+You can check that it’s reachable by visiting [http://localhost:8000/health](http://localhost:8000/health).
+
+```text
+$ curl http://localhost:8000/health
+{"status":"healthy"}
+```
+
+Uvicorn will restart the application automatically when any source files are changed.

scripts/run-dev.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+parent_path=$(cd "$(dirname "${BASH_SOURCE[0]}")"; pwd -P)
+
+python3 "${parent_path}/../src/ctp_slack_bot/api/main.py"

src/ctp_slack_bot/api/main.py

@@ -55,6 +55,6 @@ if __name__ == "__main__":
     uvicorn.run(
         "main:app",
         host="localhost", #settings.API_HOST,
-        port="8000" #settings.API_PORT,
-        #reload=settings.DEBUG,
+        port=8000, #settings.API_PORT,
+        reload=True #settings.DEBUG,
     )