Merge pull request #4 from ray-hrst/devel

Project restructuring

.gitignore

@@ -1,3 +1,4 @@
+webapp/node_modules/
 *venv/
 .DS_Store
 *.iml

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing to Jitsi-temi
+
+The following is a set of guidelines for contributing to this repository on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+#### Table Of Contents
+
+[Styleguides](#styleguides)
+  * [Git Commit Messages](#git-commit-messages)
+  * [JavaScript Styleguide](#javascript-styleguide)
+
+## Styleguides
+
+### Git Commit Messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative form ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally after the first line
+
+
+### JavaScript Styleguide
+
+Follow the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 hapi-robo s.t.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,12 +1,28 @@
 # jitsi-temi
-Jitsi for temi
+A free and open-source alternative to temi's default video-conferencing application.
 
-## Usage
-Start MQTT broker:
+
+## TL;DR
+Install APK onto temi.
+```
+adb connect <ip-address>
+adb install connect.apk
+```
+
+Start the MQTT broker and web-server:
 ```
+docker-compose build
 docker-compose up
 ```
 
-Start webapp.
+Start the `Connect` app on temi. Type in the IP-address of the MQTT broker and press `Connect`.
+
+In your web-browser, type the IP-address of the web-server.
+
+If everything is working correctly, you should see your temi's serial number appear. Click it to start tele-operations.
+
 
-Run Android App on temi.
+## Attributions
+This project would not have been made possible without the help of other open-source projects:
+* [Jitsi](https://jitsi.org/)
+* [Eclipe Paho](https://www.eclipse.org/paho/)

android/app/build.gradle

@@ -7,7 +7,7 @@ android {
         minSdkVersion 23
         targetSdkVersion 29
         versionCode 1
-        versionName "1.0"
+        versionName "0.1"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
     signingConfigs {

android/app/src/main/AndroidManifest.xml

@@ -8,7 +8,7 @@
         android:label="@string/app_name"
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
-        android:theme="@style/AppTheme">
+        android:theme="@style/SkillTheme">
         <activity android:name=".MainActivity">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
@@ -25,6 +25,10 @@
         <meta-data
             android:name="com.robotemi.sdk.metadata.SKILL"
             android:value="@string/app_name"/>
+
+        <meta-data
+            android:name="com.robotemi.sdk.metadata.KIOSK"
+            android:value="TRUE"/>
     </application>
 
 </manifest>