Skip to content

Commit e08aba0

Browse files
authored
Merge pull request #96 from EnsembleUI/switchDocs
updated switch docs and formatted files
2 parents 1984dde + ecb6de0 commit e08aba0

5 files changed

Lines changed: 47 additions & 38 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
Ensemble is a platform where you can build, publish, and iterate native and web apps without leaving your browser.
66

7-
With Ensemble, you create apps by defining them using a declarative language. Think of it as configuring your app, instead of coding it. Ensemble apps are rendered at runtime by interpreting this declerative definition. This architecture means that:
7+
With Ensemble, you create apps by defining them using a declarative language. Think of it as configuring your app, instead of coding it. Ensemble apps are rendered at runtime by interpreting this declarative definition. This architecture means that:
88

99
1. Ensemble apps are native to each platform: iOS, Android, and web.
1010
2. Ensemble apps can be updated instantly because the app definitions are pushed to clients. You can use Ensemble's cloud service, or use your own server.
11-
3. Ensemble apps always leverage the latest front-end technologies (Flutter for iOS and Android, React for web) so that you don't have to worry about tech-debt incured by using these technologies.
11+
3. Ensemble apps always leverage the latest front-end technologies (Flutter for iOS and Android, React for web) so that you don't have to worry about tech-debt incurred by using these technologies.
1212

1313
![architecture](public/images/architecture.png)
1414

1515
## How do I build my app?
1616

17-
Ensemble provides a browser-based IDE, [Ensemble Studio](https://studio.ensembleui.com), where you can build, test, and publish your apps all from the browser. You can instantly preview your Ensemble apps on iOS and Anrdoid devices using [Ensemble preview app](#preview-your-app). Once ready to publish, Ensemble automatically push your apps to Apple AppStore and Google PlayStore. For web, you can download a web build and host it on any service.
17+
Ensemble provides a browser-based IDE, [Ensemble Studio](https://studio.ensembleui.com), where you can build, test, and publish your apps all from the browser. You can instantly preview your Ensemble apps on iOS and Android devices using [Ensemble preview app](#preview-your-app). Once ready to publish, Ensemble automatically pushes your apps to Apple App Store and Google Play Store. For web, you can download a web build and host it on any service.
1818

1919
## Need help?
2020

@@ -5808,7 +5808,7 @@ For more information on Flutter integration tests, see the [Flutter Testing docu
58085808

58095809
# Preparing your App for deployment
58105810

5811-
Once you have built your UI with Ensemble and used it to build your app and are ready to take it to production, follow these instructions to deploy it to any iOS or Android devices, or to submit it to the Apple AppStore or Google Play Store.
5811+
Once you have built your UI with Ensemble and used it to build your app and are ready to take it to production, follow these instructions to deploy it to any iOS or Android devices, or to submit it to the Apple App Store or Google Play Store.
58125812

58135813
### Prerequisites
58145814
* Your Ensemble App ID. From [Ensemble Studio](https://studio.ensembleui.com), go to your App's Settings screen to retrieve the App ID.

pages/apis/api-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The basic flow is:
1212
- [Handle errors](api-on-error)
1313

1414
<Callout emoji="💡">
15-
During develoment, you can [mock APIs within Ensemble](use-mock-api-response).
15+
During development, you can [mock APIs within Ensemble](use-mock-api-response).
1616
</Callout>
1717

1818

pages/deploy/1-prepare-app.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
11
# Preparing your App for deployment
22

3-
Once you have built your UI with Ensemble and used it to build your app and are ready to take it to production, follow these instructions to deploy it to any iOS or Android devices, or to submit it to the Apple AppStore or Google Play Store.
3+
Once you have built your UI with Ensemble and used it to build your app and are ready to take it to production, follow these instructions to deploy it to any iOS or Android devices, or to submit it to the Apple App Store or Google Play Store.
44

55
### Prerequisites
6-
* Your Ensemble App ID. From [Ensemble Studio](https://studio.ensembleui.com), go to your App's Settings screen to retrieve the App ID.
6+
7+
- Your Ensemble App ID. From [Ensemble Studio](https://studio.ensembleui.com), go to your App's Settings screen to retrieve the App ID.
78

89
### Download Ensemble Starter
9-
Ensemble Starter is our packaging solution, enabling you to connect to your Ensemble UI and package it.
10-
* Clone the Starter App `git clone https://github.com/EnsembleUI/starter my_first_app` into the folder *my_first_app*. You may change the name, but don't use camelCase (e.g. myFirstApp) or dash (-) as the separators.
11-
* Follow the README in this repo.
10+
11+
Ensemble Starter is our packaging solution, enabling you to connect to your Ensemble UI and package it.
12+
13+
- Clone the Starter App `git clone https://github.com/EnsembleUI/starter my_first_app` into the folder _my_first_app_. You may change the name, but don't use camelCase (e.g. myFirstApp) or dash (-) as the separators.
14+
- Follow the README in this repo.
1215

1316
### Requesting permissions from your end-users
17+
1418
If your app requires capabilities like location, camera, ..., you will need to enter a reason per capability. These reasons will be prompted to the end users, who can decide whether to grant or deny your requests.
15-
* For iOS, edit `<my_first_app>/ios/Runner/Info.plist` and add the below permissions as the direct children of the `<dict>` tag.
16-
* For Android, edit `<my_first_app>/android/app/src/main/AndroidManifest.xml` and add the below permissions as the direct children of the `<manifest>` tag.
19+
20+
- For iOS, edit `<my_first_app>/ios/Runner/Info.plist` and add the below permissions as the direct children of the `<dict>` tag.
21+
- For Android, edit `<my_first_app>/android/app/src/main/AndroidManifest.xml` and add the below permissions as the direct children of the `<manifest>` tag.
1722

1823
Below are the snippet per capability to insert for iOS and Android respectively.
1924

2025
**Location**
26+
2127
```xml
2228
<key>NSLocationWhenInUseUsageDescription</key>
2329
<string>e.g. This app needs access to your location to ....</string>
2430
```
2531

2632
**Camera**
33+
2734
```xml
2835
<key>NSCameraUsageDescription</key>
2936
<string>e.g. your reason for requesting camera access</string>
3037

3138
<key>NSMicrophoneUsageDescription</key>
3239
<string>e.g. your reason for requesting microphone access</string>
3340
```
34-
35-

pages/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@
44

55
Ensemble is a platform where you can build, publish, and iterate native and web apps without leaving your browser.
66

7-
With Ensemble, you create apps by defining them using a declarative language. Think of it as configuring your app, instead of coding it. Ensemble apps are rendered at runtime by interpreting this declerative definition. This architecture means that:
7+
With Ensemble, you create apps by defining them using a declarative language. Think of it as configuring your app, instead of coding it. Ensemble apps are rendered at runtime by interpreting this declarative definition. This architecture means that:
88

99
1. Ensemble apps are native to each platform: iOS, Android, and web.
1010
2. Ensemble apps can be updated instantly because the app definitions are pushed to clients. You can use Ensemble's cloud service, or use your own server.
11-
3. Ensemble apps always leverage the latest front-end technologies (Flutter for iOS and Android, React for web) so that you don't have to worry about tech-debt incured by using these technologies.
11+
3. Ensemble apps always leverage the latest front-end technologies (Flutter for iOS and Android, React for web) so that you don't have to worry about tech-debt incurred by using these technologies.
1212

1313
![architecture](/images/architecture.png)
1414

1515
## How do I build my app?
1616

17-
Ensemble provides a browser-based IDE, [Ensemble Studio](https://studio.ensembleui.com), where you can build, test, and publish your apps all from the browser. You can instantly preview your Ensemble apps on iOS and Anrdoid devices using [Ensemble preview app](/test/preview-app). Once ready to publish, Ensemble automatically push your apps to Apple AppStore and Google PlayStore. For web, you can download a web build and host it on any service.
17+
Ensemble provides a browser-based IDE, [Ensemble Studio](https://studio.ensembleui.com), where you can build, test, and publish your apps all from the browser. You can instantly preview your Ensemble apps on iOS and Android devices using [Ensemble preview app](/test/preview-app). Once ready to publish, Ensemble automatically pushes your apps to Apple App Store and Google Play Store. For web, you can download a web build and host it on any service.
1818

1919
## Need help?
2020

2121
[Chat with us on Discord](https://discord.gg/cEHkJTmn75)
2222

2323
[Join our office hours](https://discord.gg/eJrUWhnRHS?event=1218554330765066310)
2424

25-
[Drop us an email](mailto:hello@ensembleui.com)
25+
[Drop us an email](mailto:hello@ensembleui.com)

0 commit comments

Comments
 (0)