review

examples/nginx_https/README.md

@@ -1,7 +1,7 @@
-# Serving an App with HTTPS encryption behind a Reverse Proxy (NGINX)
+# Serving an App with HTTPS Encryption behind a Reverse Proxy (NGINX)
 
 This example shows how to serve NiceGUI with HTTPS encryption behind NGINX.
-For running the App under a Subpath, have a look at https://github.com/zauberzeug/nicegui/blob/main/examples/nginx_subpath.
+For running the app under a subpath, have a look at https://github.com/zauberzeug/nicegui/blob/main/examples/nginx_subpath.
 
 ## Try Out
 
@@ -11,33 +11,35 @@ For running the App under a Subpath, have a look at https://github.com/zauberzeu
    mkdir certs
    ```
 
-2. Generate and self-sign SSL an certificate for `localhost`
+2. Generate and self-sign an SSL certificate for "localhost":
 
    ```bash
    openssl req -x509 -out certs/localhost.crt -keyout certs/localhost.key -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost' -extensions EXT -config <( printf "[dn]\nCN=localhost\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:localhost\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
    ```
 
-3. Run the containerized app
+3. Run the containerized app:
 
    ```bash
    docker compose up
    ```
 
-4. Try to access http://localhost without the "s".
-   You will be automatically redirected to the https version.
+4. Try to access http://localhost (without the "s").
+   You will be automatically redirected to the HTTPS version.
 
 5. Depending on your browser, you should typically receive a warning that the certificate authority is invalid.
    This is perfectly normal as we issued and self-signed a simple certificate for demo use locally.
-   So proceed anyway, e.g. on Chrome, click on `Advanced` > `Proceed to localhost (unsafe)`
+   So proceed anyway, e.g. on Chrome, click on "Advanced" > "Proceed to localhost (unsafe)".
 
-6. Note the Hello World message from the app accessed with encrypted connection
+6. Note the "Hello World" message from the app accessed with encrypted connection.
 
 ## Deploy in production in your self-hosted NGINX
 
-- For production, you'll need your own domain and a proper SSL certificate issued by a recognized Certificate Authority (CA).
-  You can consider the free CA [Let's Encrypt](https://letsencrypt.org/) provided by the Internal Security Research Group, and use their [Certbox](https://certbot.eff.org/instructions) tool to generate the certicates for your own domain.
+- For production, you will need your own domain and a proper SSL certificate issued by a recognized Certificate Authority (CA).
+  You can consider the free CA [Let's Encrypt](https://letsencrypt.org/) provided by the Internal Security Research Group, and use their [Certbox](https://certbot.eff.org/instructions) tool to generate the certificates for your own domain.
 
-- If you already have an NGINX server running and want to add your NiceGUI app, you can reuse a stripped down version of the nginx.conf file, [nginx_site.conf](https://github.com/zauberzeug/nicegui/blob/main/example/nginx_https/nginx_site.conf)
+- If you already have an NGINX server running and want to add your NiceGUI app,
+  you can reuse a stripped-down version of the nginx.conf file,
+  [nginx_site.conf](https://github.com/zauberzeug/nicegui/blob/main/example/nginx_https/nginx_site.conf).
 
 ```bash
 sudo cp nginx_site.conf /etc/nginx/sites-available/my_nicegui_app.conf

examples/nginx_https/app/main.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 from nicegui import ui
 
 ui.label('Hello HTTPS encrypted world')

website/examples.py

@@ -66,5 +66,5 @@ examples: List[Example] = [
     Example('Websockets', 'use [websockets library](https://websockets.readthedocs.io/) to start a websocket server'),
     Example('Audio Recorder', 'Record audio, play it back or download it'),
     Example('ZeroMQ', 'Simple ZeroMQ PUSH/PULL server and client'),
-    Example('NGINX Https', 'Use NGINX to serve a NiceGUI app with HTTPS'),
+    Example('NGINX HTTPS', 'Use NGINX to serve a NiceGUI app with HTTPS'),
 ]