This mono-repo holds the code for several projects that we manage. The reason for going with a mono-repo was to make code-sharing easier and reducing maintenance cost.
| Project | Link |
|---|---|
- JDK 21 (installed from IDE or web)
- Gradle 8.12.1 (installed from the wrapper)
- IDEA 2025.1 Beta
- Ensure you have the following plugins installed:
- Verify your Android SDK Manager is pointing to your android SDK (installed from IDE or web)
- Node JS
- Node Version Manager (NVM) - optional
Make sure you have SDK downloaded. You can do this manually or through the IDE. Add a local.properties file to the root dir. In the file, add sdk.dir=YOUR\\PATH\\TO\ANDROID\\SDK
To build all the projects and execute all tests run: ./gradlew releaseAll.
This is a monorepo, so there are multiple types of targets within this project. For more information about how to build and run each project is found within each project's page.
The code is configured to follow a pre-defined format style. This is enforced by the build process, so it is important to always follow the format otherwise the build process will fail. To automatically fix any format issues, just run ./gradlew ktlintf. If this task fails, you will have to manually fix the issue.
You can read more about testing in the Testing page. TODO: Update this link to point to the correct page.
To learn more about the project, please look at the documentation. TODO: Update this link to point to the correct page.