Skip to content

Home

Jump to bottom
Dmitry Sorokin (@sorydima) edited this page Nov 18, 2024 · 1 revision

Wiki for the Katya ® SetupWizard2 Repository

Welcome to the Katya ® SetupWizard2 repository! This wiki serves as your go-to resource for understanding, configuring, and contributing to the SetupWizard2 application.

Overview

The SetupWizard2 application is an essential component of the Katya ® platform, designed to provide users with a seamless and intuitive onboarding experience. It simplifies device setup, personalization, and configuration while maintaining Katya's core values of privacy, security, and usability.

Table of Contents

  1. Getting Started
  2. Repository Structure
  3. Features
  4. Installation
  5. Configuration
  6. Contributing
  7. Troubleshooting
  8. Licensing

Getting Started

To begin using or contributing to the SetupWizard2 application:

  1. Clone the Repository

    git clone https://github.com/Katya-Incorporated/platform_packages_apps_SetupWizard2.git

  2. Set Up Your Development Environment
    Ensure your system meets the prerequisites for building and testing Android applications.

  3. Explore the Codebase
    Familiarize yourself with the repository structure and primary modules.

Repository Structure

  • /src: Contains the main source code for the SetupWizard2 application.
  • /res: All resource files, including layouts, strings, and drawable assets.
  • /tests: Automated tests for verifying functionality and stability.
  • /docs: Documentation and API references.
  • /build: Build scripts and related configurations.

Features

  • Device Onboarding: Guides users through initial device setup with an intuitive UI.
  • Account Configuration: Includes support for Katya accounts and third-party integrations.
  • Personalization: Allows users to customize their device settings during setup.
  • Accessibility Options: Ensures inclusivity with support for various accessibility tools.
  • Privacy-First Design: No data collection beyond what's necessary for device configuration.

Installation

  1. Build the Application
    Use the following command to build the app:

    ./gradlew assembleDebug

  2. Deploy to an Emulator or Device

    adb install -r app/build/outputs/apk/debug/app-debug.apk

  3. Run the Application
    Launch the SetupWizard2 app on your device or emulator to test its functionality.

Configuration

The SetupWizard2 app is highly customizable:

  • Strings: Modify localized strings in the /res/values folder.
  • Layouts: Update onboarding screens in the /res/layout folder.
  • Themes: Change the app's appearance by adjusting styles in /res/values/styles.xml.
  • Modules: Add or remove setup modules by editing the /src/modules directory.

Contributing

We welcome contributions from the community to enhance the SetupWizard2 application.

  1. Fork the Repository: Create your own copy to work on.
  2. Create a Branch: Use a descriptive name for your branch.
  3. Make Changes: Implement your feature or fix.
  4. Test Your Changes: Ensure everything works as expected.
  5. Submit a Pull Request: Include a detailed description of your work.

Troubleshooting

If you encounter any issues:

  1. Check the Issues section for similar problems.
  2. Review the build logs for detailed error messages.
  3. Consult the documentation in the repository.
  4. Reach out to the community or open a new issue for support.

Licensing

The SetupWizard2 application is licensed under the Katya Open Source License. It is free to use, modify, and distribute under the terms of this license.

Let’s work together to create a flawless onboarding experience for every user!

Clone this wiki locally