Skip to content

Commit

Permalink
Solara
Browse files Browse the repository at this point in the history
  • Loading branch information
ideyaa committed Sep 19, 2024
1 parent a2ade26 commit bd7ddc1
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,47 @@ The [Solara Online Dashboard](https://solara-kit.github.io/Solara/brand/brand.ht
These tools collectively empower you to effectively manage and streamline your brand operations, whether you prefer command-line interactions, local interfaces, or online access.

Here’s a description of the Brand Configurations and how they are generated for different platforms:

### Brand Configurations

Solara allows for flexible and customizable configurations for each brand, enabling tailored settings based on specific needs. These configurations are stored in the `BRAND_KEY/shared/brand_config.json` file, serving as the central hub for brand-specific settings.

#### Brand Configurations Generation Diagram

The diagram below illustrates how the `brand_config.json` is generated for each platform, ensuring that all necessary configurations are appropriately formatted and accessible.

```
+-----------------------------------------------------------------------+
| BRAND_KEY/shared/brand_config.json |
+-----------------------------------------------------------------------+
| | |
v v v
+--------------------+ +--------------------+ +---------------------+
| Fluttter | | Android | | iOS |
+--------------------+ +--------------------+ +---------------------+
| | |
v v v
+--------------------+ +--------------------+ +---------------------+
| brand_config.dart | | BrandConfig.kt | | BrandConfig.swift |
+--------------------+ +--------------------+ +---------------------+
```

1. **Central Configuration File**
- **`BRAND_KEY/shared/brand_config.json`**: This is the main configuration file that includes all customizable settings for your brand. It acts as a template for generating platform-specific configuration files.

2. **Platform-Specific Configurations**:
- **Flutter**:
- **`brand_config.dart`**: This Dart file contains `BrandConfig` class which is generated from the central configuration for use in Flutter applications. It allows developers to access brand settings directly within the Flutter framework.

- **Android**:
- **`BrandConfig.kt`**: For Android applications, this Kotlin file is generated from the central configuration file, making them available for seamless integration into Android app development.

- **iOS**:
- **`BrandConfig.swift`**: This Swift file is generated for iOS applications, providing access to the brand configurations for iOS developers.

The generation of these platform-specific files from the central `brand_config.json` ensures that your brand configurations are consistently applied and easily manageable across different environments, enhancing the development process and user experience.

# Codebase Development

In Solara, the management of brands is the responsibility of Solara, while codebase development falls to the developer.
Expand Down

0 comments on commit bd7ddc1

Please sign in to comment.