CRamsan / CoreProject

This is a project that aims to provide a scalable architecture for mobile development.
https://cramsan.com/
1 stars 0 forks source link
android gradle kotlin

Project Repo

This mono-repo holds the code for several projects that I manage. The reason for going with a mono-repo was to make code-sharing easier and reducing maintenance cost. You can find more information about the projec's design on the design page.

You can find more documentation in the wiki.

Current Projects

Project Builds Status
Build the world Build Status
Auraxis Control Center Android Build Status
CDK Build Status
Safe for my pets Android Build Status
Webservice Build Status
Doom Desktop Build Status
Framework Samples Build Status
Dependency Updates Build Status
KotlinLibs Spring Server Build Status
Angular Site Build Status
CDK Build Status

Framework

A lot of the code is kept in a shared module called Framework that abstract a lot of complexities out of the client apps.

Getting started

Prerequisites

SDK Package

Make sure you have SDK downloaded. You can do this manually or through the IDE.

Building the code

To build all the projects and execute all tests run: ./gradlew releaseAll.

Build

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.

Formatting

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.

Testing

You can read more about testing in the Testing page.

Create a new module

If you want to start a new project and need a new module, look at the New Module page for some examples about how to get started.

More information

To learn more about the project, please look at the documentation.