|
|
@@ -1,23 +1,36 @@
|
|
|
# HybridOSN
|
|
|
|
|
|
-## Getting started
|
|
|
+HybridOSN is a [Twitter](https://www.twitter.com) client Android app allowing the user to exchange data not only via the official Twitter servers but also via a P2P network to protect his privacy. It is build using the [Ionic framework](https://ionicframework.com). With Ionic framework you can easily develop cross-platform hybrid mobile apps.
|
|
|
|
|
|
-- Install NodeJs
|
|
|
-- Set up Cordova and Ionic
|
|
|
-- Clone this repository
|
|
|
-- Install dependencies `npm i`
|
|
|
+## Development
|
|
|
|
|
|
-## How to build and run the app
|
|
|
+I highly recommend to develop the app using [Microsoft Visual Studio Code](https://code.visualstudio.com/). I also recommend to use the extensions [Prettier - Code formater](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to format your code uniformly and [Gitlens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens) to manage the git repository. Of course, you need to have git installed.
|
|
|
|
|
|
-Run on Android emulator: `ionic cordova emulate android`
|
|
|
-Run on connected Android device: `ionic cordova run android`
|
|
|
+## Getting Started
|
|
|
+
|
|
|
+- Install [NodeJS](https://nodejs.org/en/) LTS. If you have NodeJS installed on your computer but in a different version, I recommend [Node Version Manager (Windows)](https://github.com/coreybutler/nvm-windows) to handle different NodeJS installations.
|
|
|
+- Install Ionic and Cordova globally `npm install -g ionic cordova`
|
|
|
+- Clone this repository, change into the directory and install the dependencies `npm i`
|
|
|
+- **TODO** Android Studio and the Android SDK are needed, too. I have to check...
|
|
|
+
|
|
|
+## Build the App
|
|
|
+
|
|
|
+- Run on Android emulator: `ionic cordova emulate android`
|
|
|
+- Run on connected Android device: `ionic cordova run android`
|
|
|
+- Publish the APK: `ionic cordova build --release android`
|
|
|
+
|
|
|
+You may read in the Ionic docs, that you can view your app in the browser using `ionic serve`. **This doesn't work** because of the used Cordova plugins which force you to run the app on an Android device. As mentioned in the beginning, using Ionic cross-plattform applications can be developed. This still is valid, but since the goal was to develop an Android app, no time was spent on trying to remove this current restriction.
|
|
|
+
|
|
|
+## Debugging
|
|
|
+
|
|
|
+If you want to debug the app, you can do so by using the Google Chrome Developer Tools. After deploying the app on your device using the `ionic cordova run android`-command, open Google Chrome on the computer your device is connected to and press the F12-key to open the Developer Tools. Go to the tab "Remote devices" (maybe it is hidden and you need to press ESC to show it). Now you should see your connected device on the left and when selecting it the HybridOSN app. With a click on the button "Inspect" you can inspect and debug the app.
|
|
|
|
|
|
## Known Problems
|
|
|
|
|
|
-In case the build process fails with the error
|
|
|
+In case the build process fails with the error:
|
|
|
|
|
|
```
|
|
|
Execution failed for task ':app:transformDexArchiveWithExternalLibsDexMergerForDebug'.
|
|
|
```
|
|
|
|
|
|
-run `cordova clean`
|
|
|
+Run `cordova clean` to fix this problem. It appears randomly from time to time.
|
Carsten Porth