Section | Description |
---|---|
๐ฏ Objectives and context | Project introduction and context |
๐ง Dependencies | Technical dependencies and how to install them |
๐ Kickstart | Details on how to kickstart development on the project |
๐ Deploy | Deployment details for platforms and environments |
๐ Code & architecture | Details on the application modules and technical specifications |
๐ญ Possible improvements | Possible code refactors, improvements and ideas |
๐ Troubleshooting | Recurring problems and proven solutions |
โฆ
Platform | Version |
---|---|
iOS | โฅ 14.1 |
Android | โฅ 5.0 (21) |
Every runtime dependencies are defined in the .tool-versions
file. These external tools and
dependencies are also required:
- Open the root folder using Android Studio
- Run the app on your device or simulator ๐
- Open the workspace using Xcode or AppCode
- Specify your Development Team under the
Signing and Capabilities
tab of theiosApp
target - Run the app on your device or simulator ๐
Tests can be ran with ./gradlew test
.
Several linting and formatting tools can be ran to ensure coding style consistency:
./gradlew ktlintFormat
ensures Kotlin code follows our guidelines and best practicescd ios && ./Pods/SwiftLint/swiftlint
ensures Swift code follows our guidelines and best practices
The .github/workflows/ci.yaml
workflow ensures that the codebase is in good shape on each pull
request and branch push.
โฆ
โฆ
Description | Priority | Complexity | Ideas |
---|---|---|---|
โฆ | โฆ | โฆ | โฆ |
โฆ