Skip to content
Malek Kamel edited this page Sep 27, 2024 · 28 revisions

Welcome to the Solara Wiki!

Gem Version Version

Table of Contents

  • Getting Started: Essential instructions to kickstart your journey with Solara.
  • Brand Management: Comprehensive documentation on effective brand management.
  • Brands Overview: In-depth guide for understanding the Solara brands.
  • Online Dashboard: Detailed guidance on using the online dashboard for brand configurations.
  • Code Signing: Complete documentation on the code signing process for your brands.
  • Advanced Topics: Discover advanced features and configurations to enhance your Solara experience.
  • Solara Development: Detailed guidance on developing Solara.

Getting Started

Follow these steps to begin using Solara:

  1. Install the Gem: Refer to the Installation section below for detailed instructions.

  2. Run the Initialization Command:

    solara init

    This command creates two folders: solara and .solara in the root of your project. For more details, see the Brand Management documentation.

  3. Access the Brand Dashboard: The dashboard opens automatically after initialization. Update your brand configurations as necessary and click Apply Changes.


    Brand Management


    You can also access the dashboard at any time by executing solara dashboard in your terminal. For detailed instructions, please refer to Brand Management.

  4. Install the App: Deploy the app on your target simulator or device.


Ruby Installation

Before installing Solara, ensure you have Ruby installed. The minimum required version is 3.0.0.

macOS

  1. Using Homebrew: If you have Homebrew installed, you can easily install Ruby with:

    brew install ruby
  2. Using rbenv (recommended for version management):

    brew install rbenv
    rbenv install 3.0.0
    rbenv global 3.0.0

Linux

  1. Using APT (Debian/Ubuntu):

    sudo apt update
    sudo apt install ruby3.0
  2. Using rbenv (recommended):

    curl -fsSL https://github.com/rbenv/rbenv-installer/raw/main/bin/rbenv-installer | bash
    exec $SHELL
    rbenv install 3.0.0
    rbenv global 3.0.0

Windows

  1. Using RubyInstaller: Download and install RubyInstaller from the RubyInstaller website. Make sure to select the version that is 3.0.0 or higher.

  2. Using WSL (Windows Subsystem for Linux): If you prefer a Unix-like environment, you can install WSL and follow the Linux instructions above.

Solara Installation

To install Solara, add the following line to your application's Gemfile:

gem 'solara', 'x.y.z'

Make sure to replace x.y.z with the latest version number shown in the badge below:

Gem Version

Your Gemfile should look like this, incorporating the actual version:

source 'https://rubygems.org'

gem 'solara', '~> 1.2.3'
# Add any other dependencies

Then execute the following Bundler command in your terminal:

bundle install

Alternatively, you can install it directly using:

gem install solara

Need Help?Explore the Wiki for more information on effectively using Solara! If you have any questions or need further assistance, feel free to reach out. We're here to help!