These instructions are intended for developers who wish to build/run from source code. Development tested on Ubuntu Linux, however it should work on Windows, other Linux versions, or MacOS.
This is a Kotlin Multiplatform project. This repository contains the Android app and backend server source code in its modules. Android Studio is the development environment for the entire project.
-
Step 1: Download and install Android Studio: If you don't already have the latest version, download from https://developer.android.com/studio.
-
Step 2: Install dependencies
- JDK17 or JDK21
Ubuntu/Debian Linux:
sudo apt-get install openjdk-21-jdk
Windows: Download and install the Microsoft OpenJDK build from https://learn.microsoft.com/en-us/java/openjdk/install#install-on-windows.
-
Step 3: Import the project in Android Studio: Select File, New, Project from Version Control. Enter https://github.com/UstadMobile/Respect.git and wait for the project to import.
-
Step 4: Run the server: Run the server using Gradle:
Run the server from source using Gradle:
./gradlew respect-server:run
Note: On the windows command line the ./ should be omitted
-
Step 5: Add a school - each school has its own users, classes, etc. Each school instance has its own database (e.g. database for school1, school2, etc).
RESPECT supports virtual hosting enabling multiple schools to run within a single JVM instance, eg as school1.example.org, school2.example.org etc.
e.g.
./gradlew respect-server:run --args='addschool --url http://10.1.2.3:8098/ --name devschool --adminpassword secret'
Note: localhost won't work on Android emulators and devices because localhost refers to the emulator/device itself not the PC running on the server.
To see all available command line options (including database options etc):
./gradlew respect-server:run --args='addschool --help'
Note: in order for the search by school name to work you must add your server to the app directory list (default or local) (e.g. http://10.1.2.3:8098/ as above) in directories
- Step 6: Build/run and Android app: In Android Studio use the run/debug button to run the
respect-app-composemodule. See respect-app-compose for further details on running via the command line etc.
Join our Community Slack Space.
Copyright 2024-2025 UstadMobile FZ-LLC. This code is substantially derived from UstadMobile. Documentation: CC-BY license. Code and all other works: AGPLv3 license.