Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Lathryx/Scriptable-Getting-Started-Guide
A getting started guide to the Scriptable mobile app for iOS.
https://github.com/Lathryx/Scriptable-Getting-Started-Guide
documentation getting-started guide how-to howto ios scriptable-app
Last synced: 2 months ago
JSON representation
A getting started guide to the Scriptable mobile app for iOS.
- Host: GitHub
- URL: https://github.com/Lathryx/Scriptable-Getting-Started-Guide
- Owner: Lathryx
- License: mit
- Created: 2020-11-04T22:34:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-11T21:50:10.000Z (about 4 years ago)
- Last Synced: 2024-03-26T16:29:54.851Z (9 months ago)
- Topics: documentation, getting-started, guide, how-to, howto, ios, scriptable-app
- Homepage: https://scriptable.app
- Size: 13.7 KB
- Stars: 20
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### What *is* [Scriptable](https://scriptable.app/)?
Scriptable is a mobile application for iOS created to enable anyone to easily integrate with the iOS backend. Its simple syntax allows for lots of flexability. Scriptable uses *Javascript*. Scriptable allows for developers to prototype, test, preview, and much more. It was developed by [Simon B. Støvring](https://simonbs.dk/), the creator of various other apps such as [Jayson](https://jayson.app/) and [Data Jar](https://datajar.app/).
Scriptable, according to their [official website](https://scriptable.app/), currently consists of the following features:
> **Plain Javascript**
> - Supports JavaScript ES6. Scripts are stored as plain JS files on disk.
>
> **Native APIs**
> - Integrate with the native APIs of iOS directly from JavaScript.
>
> **Siri Shortcuts**
> - Run scripts from Siri Shortcuts. Present tables, websites, HTML and more in Siri.
>
> **Documentation**
> - All native APIs that are bridged to JavaScript have documentation which is available offline.
>
> **Share Sheet Extension**
> - Run a script from a share sheet and process the inputs.
>
> **Files Integration**
> - Integrated with the file system and Files.app enabling you to perform operations on files.
>
> **Customizable**
> - The editor can be customized to match your preferences.
>
> **Example scripts**
> - Comes with several example scripts to get you started.
>
> **x-callback-url**
> - Communicate with other apps using x-callback-url.
By using Scriptable, you have the benefit of easily integrating with iOS without the need for a Developer license; it's a great tool for the average consumer, or a full-time developer.
## Getting Started
Though Scriptable has its own documentation, found [here](https://docs.scriptable.app/), it could be difficult to get started using their API. This guide will act to help with that.
**This guide assumes the following:**
- A good understanding of Javascript.
- Some good references for Javascript can be found on [w3schools](https://www.w3schools.com/js/js_intro.asp) or [MDN web docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide). Good beginner courses can be found on [Codecademy](https://www.codecademy.com/learn/introduction-to-javascript) or [SoloLearn](https://www.sololearn.com/Course/JavaScript/?ref=app).
- Access to an iOS device.
- iOS 14 or later.
- You have the [Scriptable app](https://apps.apple.com/us/app/scriptable/id1405459188) or [Testflight beta](https://testflight.apple.com/join/uN1vTqxk).
Further updates, announcements, or assisstance can be found on the unofficial Scriptable [subreddit](https://reddit.com/r/scriptable/) and [Discord server](https://discord.gg/fsguJthT).
## Helpful Links of Information
Below is a list of links containing information that may help while you are programming. (reference)
- [List of time zones for use in the Date.toLocaleDateString method](https://gist.github.com/rxaviers/8481876).