@servicetitan/docs-anvil-uikit-contrib 25.0.1-canary.0 → 25.0.1

package/docs/backendless.md

@@ -0,0 +1,35 @@
+---
+id: backendless
+title: Backendless
+---
+
+Backendless lets you develop the frontend in the monolith app without running the backend.
+
+## Setup
+
+1. `cd` to your **app** project, then to `Clients/Web`
+2. Run `npm start`
+3. Run `npm run wwwroot` (admin or sudo rights are required to generate a trusted HTTPS certificate during the first run)
+4. In a browser, open https://next.servicetitan.com/manage (or any other current environment), and login with your ServiceTitan credentials.
+5. Open the developer console (**CTRL+Shift+J** on PC or **CMD+OPT+J** on Mac), and run `backendless.start()`
+6. The ST page should reload and you should now see the Backendless logo
+7. Have a happy development! 🙂
+
+To deactivate Backendless, you can run `backendless.end()` or unregister the Backendless service worker via the developer tools.
+
+*If you find any issues or have additional questions, please post them in the [#dev-backendless](https://servicetitan.slack.com/archives/C018D8C088L) Slack channel.*
+
+## Troubleshooting
+
+### WSL Certificate
+
+If you are using WSL2 on Windows, and are running `npm run wwwroot` from within WSL, you may experience an issue with your browser in Windows not trusting the certificate that gets generated and used for localhost.
+
+One solution is to run `npm run wwwroot` from Windows instead of WSL, so that the certificate will get correctly installed and trusted within Windows.
+
+There is another, longer solution that will allow you to continue running the script from within WSL after some setup.
+1. Run `npm run wwwroot` within WSL first, so that WSL will know it generated a certificate already. Those certificates will likely be added to `/home/[UBUNTU_USERNAME]/.config/https-localhost/localhost.crt`.
+2. Run `npm run wwwroot` within Windows. This may require you cloning the repo again from Windows, and will require node to be installed on Windows. This will add certificates to `C:\Users\[USERNAME]\AppData\Roaming\https-localhost`.
+3. Copy the **localhost.crt** and **localhost.key** from `C:\Users\[username]\AppData\Roaming\https-localhost` to `/home/[UBUNTU_USERNAME]/.config/https-localhost/localhost.crt`. The WSL mount can be accessed from Windows via `\\wsl$\Ubuntu\home\[UBUNTU_USERNAME]]\.config\https-localhost\localhost.crt`.
+
+From then on, you should be able to run `npm run wwwroot` directly from WSL with no issues, because it is serving using the certificate generated from Windows and Windows trusts that certificate.

package/package.json

@@ -1,15 +1,13 @@
 {
     "name": "@servicetitan/docs-anvil-uikit-contrib",
-    "version": "25.0.1-canary.0",
+    "version": "25.0.1",
     "description": "",
     "repository": {
         "type": "git",
         "url": "https://github.com/servicetitan/anvil-uikit-contrib.git",
         "directory": "packages/docs"
     },
-    "files": [
-        "docs"
-    ],
+    "files": ["docs"],
     "publishConfig": {
         "access": "public"
     },