Skip to content

Commit 77bc4bf

Browse files
committed
Update deployment methods documentation and improve home page content; correct README link for webviewer package
1 parent e8c5dbc commit 77bc4bf

File tree

5 files changed

+40
-39
lines changed

5 files changed

+40
-39
lines changed

apps/docs/content/docs/cli/webviewer/deployment-methods.mdx

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,11 @@ There are many ways to deploy WebViewer code to your FileMaker file, and each me
99

1010
This technique stores the WebViewer code as **data** directly in your FileMaker file. This is the default method for most WebViewer integrations and the method used when setting up a new project with the ProofKit CLI.
1111

12-
#### Pros
13-
14-
- Simple to setup and understand
15-
- Works offline
16-
17-
#### Cons
18-
19-
- Doesn't survive data migrations
20-
- Unable to use server-side JavaScript libraries
21-
- Updates requires the web developer to have access to the FileMaker file
12+
| Pros | Cons |
13+
|----------------------------------------|----------------------------------------------------------------------|
14+
| ✅ Simple to setup and understand | ⚠️ Doesn't survive data migrations |
15+
| ✅ Works offline | ⚠️ Unable to use server-side JavaScript libraries |
16+
| | ⚠️ Updates requires the web developer to have access to the FileMaker file |
2217

2318
#### Considerations
2419

@@ -36,17 +31,11 @@ To get around the data migration issue, you have a few options:
3631

3732
In the other extreme, you can host the WebViewer code like you would any other web application. If you're only using the @proofkit/webviewer library, you can still do this without any security concerns because the data won't load unless the web page is loaded in your FileMaker solution in a WebViewer.
3833

39-
#### Pros
40-
41-
- Code survives data migrations
42-
- Can use server-side JavaScript libraries
43-
- Can deploy updates to the web code without a data migration
44-
45-
#### Cons
46-
47-
- Requires a web server, or hosting account with Vercel (or similar)
48-
- Code is de-coupled from the FileMaker file, which may cause schema to be out of sync if you're not careful
49-
- Requires a persistent internet connection
34+
| Pros | Cons |
35+
|----------------------------------------|----------------------------------------------------------------------|
36+
| ✅ Code survives data migrations | ⚠️ Requires a web server, or hosting account with Vercel (or similar) |
37+
| ✅ Can use server-side JavaScript libraries | ⚠️ Code is de-coupled from the FileMaker file, which may cause schema to be out of sync if you're not careful |
38+
| ✅ Can deploy updates to the web code without a data migration | ⚠️ Requires a persistent internet connection |
5039

5140
#### Implementation
5241

@@ -66,13 +55,19 @@ Alternatively, you can just install the `@proofkit/webviewer` library into a sta
6655

6756
This technique is a hybrid of the embedded and hosted methods. Essentially, the code is embedded in the FileMaker file, but you also host a copy of it on another web server. The FileMaker file (or the web code) can check for updates and download the latest version directly to the the neccesary field.
6857

69-
#### Pros
70-
71-
- Enables a self-updating solution
72-
- Great for non-hosted files, or a vertical-market solution where each copy may need a different version of the WebViewer code
73-
- Can work offline, after the initial download
74-
75-
#### Cons
76-
77-
- Requires a server to host a copy of the code (but can be a simple static file host or CDN)
78-
- More complex to setup and maintain
58+
| Pros | Cons |
59+
|----------------------------------------|----------------------------------------------------------------------|
60+
| ✅ Enables a self-updating solution | ⚠️ Requires a server to host a copy of the code (but can be a simple static file host or CDN) |
61+
| ✅ Great for non-hosted files, or a vertical-market solution where each copy may need a different version of the WebViewer code | ⚠️ More complex to setup and maintain |
62+
| ✅ Can work offline, after the initial download | |
63+
64+
## Comparison Table
65+
66+
| Feature | Embedded | Hosted | Downloaded |
67+
|--------------------------------------------|------------------|------------------|------------------|
68+
| **Simple Setup** || ⚠️ (needs hosting) | ⚠️ (hybrid setup) |
69+
| **Survives Data Migrations** ||||
70+
| **Works Offline** ||| ✅ (after download) |
71+
| **Web Server Required?** | No | Yes | Simple (static file host or CDN) |
72+
| **Can Use Server-side JS Libraries** ||||
73+
| **Update Method** | ⚠️ File migration (downtime) | ✅ Simplest (no downtime) | ✅ Self-updating, no downtime |

apps/docs/content/docs/webviewer/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { Accordion, Accordions } from "fumadocs-ui/components/accordion";
1111

1212
The goal of this package is to make it easy to work with FileMaker scripts and data when building a custom webviewer integration. @proofkit/webviewer works only inside of webviewer and allows you to interact with your FileMaker solution via local scripts.
1313

14-
This is a **client-side** package, meant to run specifically in a FileMaker WebViewer, but it can still be used in a hosted web app, such as Next.js. However, it will cause errors if loaded in a standard browser. For more information about deployment strategies, see the [Deployment](/docs/deployment) page.
14+
This is a **client-side** package, meant to run specifically in a FileMaker WebViewer, but it can still be used in a hosted web app, such as Next.js. However, it will cause errors if loaded in a standard browser. For more information about deployment strategies, see the [Deployment](/docs/cli/webviewer/deployment-methods) guide (from the CLI docs).
1515

1616
For web-based applications where you're looking to interact with the Data API using a network request, check out the [@proofkit/fmdapi](/docs/fmdapi) package instead.
1717

apps/docs/src/app/(home)/page.tsx

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,21 @@ export default function HomePage() {
3636
</div>
3737

3838
<div className="mt-8 space-y-8 text-center w-full ">
39-
<h1 className="text-4xl font-bold">Welcome</h1>
39+
<h1 className="text-4xl font-bold">
40+
A collection of tools for FileMaker-aware JavaScript applications
41+
</h1>
4042
<p className="text-xl text-gray-500 font-medium">
41-
A collection of tools for building great JavaScript applications
43+
For new and experienced developers alike, ProofKit is the best way
44+
build web apps connected to FileMaker data, or full interfaces in a
45+
FileMaker webviewer.
4246
</p>
4347

4448
<Cards className="px-4 text-left">
4549
<Card icon={<Terminal />} title="ProofKit CLI" href="/docs/cli">
4650
A command line tool to start a new project, or easily apply
47-
templates and common patterns.
51+
templates and common patterns with{" "}
52+
<span className="underline">no JavaScript experience</span>{" "}
53+
required.
4854
</Card>
4955
<Card icon={<Code />} href="/docs/typegen" title={"Typegen"}>
5056
Automatically generate runtime validators and TypeScript files
@@ -63,8 +69,8 @@ export default function HomePage() {
6369
title="FileMaker Webviewer"
6470
href="/docs/webviewer"
6571
>
66-
Use async functions in WebViewer code to run and get results from
67-
FileMaker scripts.
72+
Use async functions in WebViewer code to execute and get the
73+
result of a FileMaker script.
6874
</Card>
6975
</Cards>
7076

packages/webviewer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This is a fetch replacement for calling a FileMaker script and getting a promise back in return. Or you can use callback if you want instead.
66

7-
**[Documentation Website](https://proofkit.com/docs/webviewer)**
7+
**[Documentation Website](https://proofkit.dev/docs/webviewer)**
88

99
Install via your package manager of choice:
1010

packages/webviewer/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@proofkit/webviewer",
3-
"version": "3.0.2",
3+
"version": "3.0.4",
44
"description": "A utility to fetch data from FileMaker webviewer",
55
"type": "module",
66
"files": [

0 commit comments

Comments
 (0)