Updated docs + new websockets guide

turukawa · turukawa · commit a76587d8df5a · 2023-08-26T18:10:46.000+02:00
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ This is a comprehensively updated fork of [Sebastián Ramírez's](https://github
   - [Development and installation](./docs/development-guide.md)
   - [Deployment for production](./docs/deployment-guide.md)
   - [Authentication and magic tokens](./docs/authentication-guide.md)
+  - [Websockets for interactive communication](./docs/websocket-guide.md)
 - [More details](#more-details)
 - [Help needed](#help-needed)
 - [Release notes](#release-notes)
@@ -78,6 +79,7 @@ This FastAPI, PostgreSQL, Neo4j & Nuxt 3 repo will generate a complete web appli
 - [Development and installation](./docs/development-guide.md)
 - [Deployment for production](./docs/deployment-guide.md)
 - [Authentication and magic tokens](./docs/authentication-guide.md)
+- [Websockets for interactive communication](./docs/websocket-guide.md)
 
 ## More details
 
@@ -99,6 +101,18 @@ The tests are broken and it would be great if someone could take that on. Other
 
 ## Release Notes
 
+See notes and [releases](https://github.com/whythawk/full-stack-fastapi-postgresql/releases). 
+
+## 0.8.2
+
+Fixing [#39](https://github.com/whythawk/full-stack-fastapi-postgresql/issues/39), thanks to @a-vorobyoff:
+
+- Exposing port 24678 for Vite on frontend in development mode.
+- Ensuring Nuxt content on /api/_content doesn't interfere with backend /api/v routes.
+- Checking for password before hashing on user creation.
+- Updating generated README for Hatch (after Poetry deprecation).
+- Minor fixes.
+
 ### 0.8.1
 
 - Minor updates to Docker scripts for `build`.
@@ -124,50 +138,6 @@ The tests are broken and it would be great if someone could take that on. Other
 - Fixed: Updated token url in deps.py [#29](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/29) by @vusa
 - Docs: Reorganised documentation [#21](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/21) by @turukawa
 
-### 0.7.3
-- @nuxt/content 2.2.1 -> 2.4.3
-- Fixed: `@nuxt/content` default api, `/api/_content`, conflicts with the `backend` api url preventing content pages loading.
-- Documentation: Complete deployment guide in `DEPLOYMENT-README.md` (this has now been moved to `/docs`)
-
-### 0.7.2
-- Fixed: URLs for recreating project in generated `README.md`. PR [#15](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/15) by @FranzForstmayr
-- Fixed: Absolute path for mount point in `docker-compose.override.yml`. PR [#16](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/16) by @FranzForstmayr
-- Fixed: Login artifacts left over from before switch to magic auth. PR [#18](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/18) by @turukawa and @FranzForstmayr
-- New: New floating magic login card. PR [#19](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/19) by @turukawa
-- New: New site contact page. PR [#20](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/20) by @turukawa
-
-### 0.7.1
-
-- SQLAlchemy 1.4 -> 2.0
-- Nuxt.js 3.0 -> 3.2.2
-- Fixed: `tokenUrl` in `app/api/deps.py`. Thanks to @Choiuijin1125.
-- Fixed: SMTP options for TLS must be `ssl`. Thanks to @raouldo.
-- Fixed: `libgeos` is a dependency for `shapely` which is a dependency for `neomodel`, and which doesn't appear to be installed correctly on Macs. Thanks to @valsha and @Mocha-L.
-- Fixed: `frontend` fails to start in development. Thanks to @pabloapast and @dividor.
-
-### 0.7.0
-
-- New feature: magic (email-based) login, with password fallback
-- New feature: Time-based One-Time Password (TOTP) authentication
-- Security enhancements to improve consistency, safety and reliability of the authentication process (see full description in the frontend app)
-- Requires one new `frontend` dependency: [QRcode.vue](https://github.com/scopewu/qrcode.vue)
-
-### 0.6.1
-
-- Corrected error in variable name `ACCESS_TOKEN_EXPIRE_SECONDS`
-
-### 0.6.0
-
-- Inboard 0.10.4 -> 0.37.0, including FastAPI 0.88
-- SQLAlchemy 1.3 -> 1.4
-- Authentication refresh token tables and schemas for long-term issuing of a new access token.
-- Postgresql 12 -> 14
-- Neo4j pinned to 5.2.0
-- Nuxt.js 2.5 -> 3.0
-- Pinia for state management (replaces Vuex)
-- Vee-Validate 3 -> 4
-- Tailwind 2.2 -> 3.2
-
 [Historic changes from original](https://github.com/tiangolo/full-stack-fastapi-postgresql#release-notes)
 
 ## License
diff --git a/docs/authentication-guide.md b/docs/authentication-guide.md
@@ -4,6 +4,7 @@
 2. [Development and installation](development-guide.md)
 3. [Deployment for production](deployment-guide.md)
 4. [Authentication and magic tokens](authentication-guide.md)
+5. [Websockets for interactive communication](websocket-guide.md)
 
 ---
 
diff --git a/docs/deployment-guide.md b/docs/deployment-guide.md
@@ -4,6 +4,7 @@
 2. [Development and installation](development-guide.md)
 3. [Deployment for production](deployment-guide.md)
 4. [Authentication and magic tokens](authentication-guide.md)
+5. [Websockets for interactive communication](websocket-guide.md)
 
 ---
 
diff --git a/docs/development-guide.md b/docs/development-guide.md
@@ -4,6 +4,7 @@
 2. [Development and installation](development-guide.md)
 3. [Deployment for production](deployment-guide.md)
 4. [Authentication and magic tokens](authentication-guide.md)
+5. [Websockets for interactive communication](websocket-guide.md)
 
 ---
 
@@ -90,6 +91,25 @@ And start them:
 docker-compose up -d 
 ```
 
+By default, `backend` Python dependencies are managed with [Hatch](https://hatch.pypa.io/latest/). From `./backend/app/` you can install all the dependencies with:
+
+```console
+$ hatch env prune
+$ hatch env create production
+```
+
+Because Hatch doesn't have a version lock file (like Poetry), it is helpful to `prune` when you rebuild to avoid any sort of dependency hell. Then you can start a shell session with the new environment with:
+
+```console
+$ hatch shell
+```
+
+Make sure your editor uses the environment you just created with Hatch. For Visual Studio Code, from the shell, launch an appropriate development environment with:
+
+```console
+$ code .
+```
+
 **NOTE:** The Nuxt image does not automatically refresh while running in development mode. Any changes will need a rebuild. This gets tired fast, so it's easier to run Nuxt outside Docker and call through to the `backend` for API calls. You can then view the frontend at `http://localhost:3000` and the backend api endpoints at `http://localhost/redoc`. This problem won't be a concern in production.
 
 Change into the `/frontend` folder, and:
@@ -99,8 +119,6 @@ yarn install
 yarn dev
 ```
 
-Be careful about the version of `Node.js` you're using. As of today (December 2022), the latest Node version supported by Nuxt is 16.18.1.
-
 FastAPI `backend` updates will refresh automatically, but the `celeryworker` container must be restarted before changes take effect.
 
 ## Starting Jupyter Lab
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -4,6 +4,7 @@
 2. [Development and installation](development-guide.md)
 3. [Deployment for production](deployment-guide.md)
 4. [Authentication and magic tokens](authentication-guide.md)
+5. [Websockets for interactive communication](websocket-guide.md)
 
 ---
 
@@ -104,35 +105,41 @@ After using this generator, your new project will contain an extensive `README.m
 
 See notes and [releases](https://github.com/whythawk/full-stack-fastapi-postgresql/releases). The last four release notes are listed here:
 
-### 0.7.3
-- @nuxt/content 2.2.1 -> 2.4.3
-- Fixed: `@nuxt/content` default api, `/api/_content`, conflicts with the `backend` api url preventing content pages loading.
-- Documentation: Complete deployment guide in `DEPLOYMENT-README.md` (this has now been moved to `/docs`)
+## 0.8.2
 
-### 0.7.2
-- Fixed: URLs for recreating project in generated `README.md`. PR [#15](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/15) by @FranzForstmayr
-- Fixed: Absolute path for mount point in `docker-compose.override.yml`. PR [#16](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/16) by @FranzForstmayr
-- Fixed: Login artifacts left over from before switch to magic auth. PR [#18](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/18) by @turukawa and @FranzForstmayr
-- New: New floating magic login card. PR [#19](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/19) by @turukawa
-- New: New site contact page. PR [#20](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/20) by @turukawa
+Fixing [#39](https://github.com/whythawk/full-stack-fastapi-postgresql/issues/39), thanks to @a-vorobyoff:
 
-### 0.7.1
+- Exposing port 24678 for Vite on frontend in development mode.
+- Ensuring Nuxt content on /api/_content doesn't interfere with backend /api/v routes.
+- Checking for password before hashing on user creation.
+- Updating generated README for Hatch (after Poetry deprecation).
+- Minor fixes.
 
-- SQLAlchemy 1.4 -> 2.0
-- Nuxt.js 3.0 -> 3.2.2
-- Fixed: `tokenUrl` in `app/api/deps.py`. Thanks to @Choiuijin1125.
-- Fixed: SMTP options for TLS must be `ssl`. Thanks to @raouldo.
-- Fixed: `libgeos` is a dependency for `shapely` which is a dependency for `neomodel`, and which doesn't appear to be installed correctly on Macs. Thanks to @valsha and @Mocha-L.
-- Fixed: `frontend` fails to start in development. Thanks to @pabloapast and @dividor.
+### 0.8.1
 
-### 0.7.0
+- Minor updates to Docker scripts for `build`.
 
-- New feature: magic (email-based) login, with password fallback
-- New feature: Time-based One-Time Password (TOTP) authentication
-- Security enhancements to improve consistency, safety and reliability of the authentication process (see full description in the frontend app)
-- Requires one new `frontend` dependency: [QRcode.vue](https://github.com/scopewu/qrcode.vue)
+### 0.8.0
 
-[Historic changes from original](https://github.com/tiangolo/full-stack-fastapi-postgresql#release-notes)
+- Updates to `frontend`, [#37](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/37) by @turukawa:
+  - `@nuxtjs/i18n` for internationalisation, along with language selection component.
+  - `@vite-pwa/nuxt` along with button components for install and refreshing the app and service workers, and a CLI icon generator.
+  - `@nuxtjs/robots` for simple control of `robots.txt` permissions from `nuxt.config.ts`.
+
+### 0.7.4
+
+- Updates: Complete update of stack to latest long-term releases. [#35](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/35) by @turukawa, review by @br3ndonland
+  - `frontend`:
+    - Node 16 -> 18
+	- Nuxt 3.2 -> 3.6.5
+    - Latest Pinia requires changes in stores, where imports are not required (cause actual errors), and parameter declaration must happen in functions.
+  - `backend` and `celeryworker`:
+    - Python 3.9 -> 3.11
+    - FastAPI 0.88 -> 0.99 (Inboard 0.37 -> 0.51)
+    - Poetry -> Hatch
+    - Postgres 14 -> 15
+- Fixed: Updated token url in deps.py [#29](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/29) by @vusa
+- Docs: Reorganised documentation [#21](https://github.com/whythawk/full-stack-fastapi-postgresql/pull/21) by @turukawa
 
 ## License
 
diff --git a/docs/websocket-guide.md b/docs/websocket-guide.md
