https://github.com/bsorrentino/mermaid4ipad
An AI powered Mermaid Editor App for iPad
https://github.com/bsorrentino/mermaid4ipad
Last synced: 13 days ago
JSON representation
An AI powered Mermaid Editor App for iPad
- Host: GitHub
- URL: https://github.com/bsorrentino/mermaid4ipad
- Owner: bsorrentino
- License: mit
- Created: 2024-07-24T14:34:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-28T17:54:34.000Z (11 months ago)
- Last Synced: 2025-01-16T15:47:57.009Z (10 months ago)
- Language: Swift
- Size: 235 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Mermaid4iPad
## Description
> Native Mermaid Editor thought for iPad providing a improved user experience to use this popular "diagram-as-code" tool
This is a native Mermaid editor app for iPad. It allows using iPad to draw diagrams in effective way. It includes use of AI to helping drawing process. take note that to enable AI features you **MUST HAVE** a valid "OpenAI API key" i.e. OpenAI Paid Account
_Promotional Text_ 🤞
> This is a native App designed iPad with AI capabilities to create and edit Mermaid's type Diagrams . Developed to enjoy the diagram writing on this excellent device
## Features 🦾
1. [x] Create,Update,Delete Mermaid Documents
2. [x] Share Documents with iCloud
3. [x] OpenAI integration
> **You MUST HAVE a valid [OpenAI] API KEY (i.e. Paid Account)** to use this feature. Such secrets will be stored in device's keychain
4. [x] Drawing
* Draw Diagram using either Pencil or Fingers.
* Processing hand drawn diagram through [OpenAI Vision API] (_gpt-4o_) to automatically genearte Mermaid script.
* Mermaid script will include also a legend with detailed description of drawing.
5. [x] Prompt
* Prompt your diagram request in natural language
* Undo Prompt
* Prompt's History
* choose AI Model (_gpt-4o-mini or gpt-4o_)
4. [x] Text Editor
* Auto save over modification
* Provide **syntax highlighting** and auto completion **diagram snippets** through [ace] editor
5. Diagram Preview
* Scale to fit
* Share Image (AirDrop, iCloud, Other App, ...)
**Release:**
* **Release 1.0**
> first official release.
## App Store
See the App on [App Store](https://apps.apple.com/us/app/mermaidrawing-app/id6737563358) 👀
## References
* [Mermaid] - Diagramming and charting tool
[Mermaid]: https://mermaid.js.org
[openai]: https://openai.com
[ace]: https://ace.c9.io
[OpenAI Vision API]: https://platform.openai.com/docs/guides/vision
[LangGraph-Swift]: https://github.com/bsorrentino/LangGraph-Swift