Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 19 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,30 @@
# Mintlify Starter Kit
# Hand Gesture Camera Prototype

Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
Mobile-first, full-screen web app that opens your phone camera and detects two gestures in real-time: thumbs up and fist. Built with MediaPipe Tasks (Hand Landmarker) and deployable to Netlify as a static site.

- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components

### Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
## Run locally
Use a simple static server (required for camera permissions):

```
npm i -g mintlify
cd app
python3 -m http.server 5173
```

Run the following command at the root of your documentation (where docs.json is)
Then open `http://localhost:5173`.

## Deploy to Netlify
With Netlify CLI:

```
mintlify dev
npm i -g netlify-cli
netlify login
netlify deploy --dir=app --message "gesture prototype"
# optional production
netlify deploy --prod --dir=app
```

### Publishing Changes

Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

#### Troubleshooting
Or drag-and-drop the `app/` folder in the Netlify UI. Camera runs over HTTPS on your draft/production URL.

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `docs.json`
## Notes
- On iOS Safari, ensure camera permission is allowed in Settings if blocked.
- Detection is heuristic-based for a quick prototype; lighting and pose affect accuracy.
33 changes: 33 additions & 0 deletions app/.netlify/netlify.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
headersOrigin = "config"
plugins = []
redirects = []

[functions]

[functions."*"]

[build]
publish = "/workspace/app/app"
publishOrigin = "config"
base = "/workspace/app"

[build.environment]

[build.processing]

[build.processing.css]

[build.processing.html]

[build.processing.images]

[build.processing.js]

[build.services]

[[headers]]
for = "/wasm/*"

[headers.values]
Cross-Origin-Embedder-Policy = "require-corp"
Cross-Origin-Opener-Policy = "same-origin"
Loading