diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8be8a9d --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +# Python +__pycache__/ +*.py[cod] +.venv/ +venv/ +*.egg-info/ + +# Local env / secrets +.env + +# Local SQLite dev database +*.db +wpsuite.db diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md index a13c522..3ac9464 100644 --- a/DEPLOYMENT.md +++ b/DEPLOYMENT.md @@ -1,153 +1,57 @@ -# Deployment & Feedback Collection +# Deployment -The Work Package Suite is a **static client-side app** — plain HTML, CSS, and -JavaScript. There is no build step and no database. +The Work Package Suite has two parts: -## Hosting it behind the firewall +- a **static front end** (plain HTML/CSS/JS — no build step), and +- a **Python API** (FastAPI) backed by **PostgreSQL**, which stores the project + SOPs, Work Packages, and comments so they are shared across users instead of + living in each person's browser. -Copy the whole folder to any internal web server and serve it over HTTP(S): - -- **IIS / Apache / nginx** — drop the files in the site root. `index.html` is the - entry point. -- **SharePoint / network share** — works too, as long as the files are served - over `http(s)://` (not opened as `file://...`). Serving over HTTP makes - `localStorage` and the embedded Work Package Creator (an `