Skip to content

Commit

Permalink
Update documentation to remove tabris connect references
Browse files Browse the repository at this point in the history
Point to the GitHub actions migration guide instead.

Change-Id: Icc8ef325cb4f4333d34809584be80dab12ee0228
  • Loading branch information
tbuschto committed Jun 30, 2023
1 parent e16a9b3 commit f66d377
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 36 deletions.
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,6 @@ Tabris.js also adds support for many key web technologies including:
- _WebSockets_
- _localStorage_


## Online build

To package your source into a installable app, Tabris.js features an online [build service](https://tabrisjs.com/documentation/latest/build). There is no need to download a huge SDK or use specific hardware for development (e.g. a Mac machine to build for iOS). A [local build](https://tabrisjs.com/documentation/latest/local-build) is also available as an option if more customization is needed.


## Build tabris npm module

Follow these steps if you want to build the tabris module yourself.
Expand Down
38 changes: 8 additions & 30 deletions doc/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,7 @@
---
# Building a Tabris.js App

Tabris.js utilizes [Apache Cordova](http://cordova.apache.org) to build and package apps. Apps can be built without any local setup [using the free online build service](#build-service) on tabrisjs.com. To [build an app on your local machine](#local-build), you need to setup developer tools like Xcode, Visual Studio or the Android SDK. The following features are supported by the two different build types.

| | Build Service | Local Build
|---------------------------|---------------|------------
| Building iOS Apps |✓|✓
| Building Android Apps|✓|✓
| npm "build" Script|||
| [Integrate Cordova Plugins](cordova.md)|✓|✓
| [Cordova Build Hooks](http://cordova.apache.org/docs/en/edge/guide_appdev_hooks_index.md.html)|✓|✓
| Custom Project Structure|||
| Using own build hardware|||
| Other SCMs than Git|||
| Custom Build Environment|||

> :point_right: The online build service is free for unlimited public GitHub repositories and 1 private repository. To build from unlimited private repositories, you need a [Pro account](https://tabrisjs.com/pricing/). [Local builds](#local-build) are free for everyone.
Tabris.js utilizes [Apache Cordova](http://cordova.apache.org) to build and package apps. To [build an app on your local machine](#local-build), you need to setup developer tools like Xcode, Visual Studio or the Android SDK. You can also build on a [build service](#build-service) like GitHub Actions.

## Project Layout

Expand Down Expand Up @@ -196,16 +182,6 @@ The following folders are excluded by default and don't have to be listed in the
* `build/`
* The file `.tabrisignore` itself

## Build Service

[Tabrisjs.com](https://tabrisjs.com) offers a free online build service for Tabris.js apps. After signing in you can create an app in the "My Apps" section by clicking "Create App". Now you can select your GitHub repository in the list of repositories (if it’s not visible you may need to press the "synchronize" button). Users on the [Pro plan](https://tabrisjs.com/pricing/) can also use self hosted Git repositories.
![Create an App](img/build-create-app.png)
After you have selected your repository it’s going to be validated. The validation checks if the selected repository contains a valid Tabris.js [project layout](build.md#project-layout). If you have a valid project structure and `config.xml`, your app should become valid shortly. If it’s invalid, the site will tell you what went wrong. In this case please follow the instructions displayed.
![Valid App](img/build-valid-app.png)
After your app has become valid, you are ready to execute the first build. Just select the newly created app and click the "Start Android Build" button. A few minutes later you will get an Android .apk file which is ready to be installed on your device. But what about iOS, production builds and signing? All these things can be configured using the "Settings".

> :point_right: The build service installs the dependencies specified in your package.json from npm (except devDependencies). As a result, you don't have to put the `node_modules` folder under version control.
### Settings

![App Settings](img/build-app-settings.png)
Expand Down Expand Up @@ -237,17 +213,19 @@ The Tabris CLI must be installed globally on your system:
npm install -g tabris-cli
```

You also need an account on [tabrisjs.com](https://tabrisjs.com). A free account is sufficient.

### Building an App

On the first start, the Tabris CLI will ask for a build key.
You can find this key on your [profile page](https://tabrisjs.com/settings/account).

To build your app, run

```
tabris build [android|ios]
```

For more command-line options, please refer to the [CLI documentation](https://www.npmjs.com/package/tabris-cli).

> :point-right: If the Tabris CLI asks for a build key or fails to download the tabris platform with an HTTP 400 error, make sure you have at least version 3.9.1 of the CLI installed.

## Build Service

The tabris build service has been discontinued. We now recommend building with GitHub actions. You can find a migration guide and example app [here](https://github.com/eclipsesource/tabris-connect-migration-guide).

0 comments on commit f66d377

Please sign in to comment.