Skip to content

SETUP.md

Latest commit

 

History

History
58 lines (42 loc) · 1.37 KB

SETUP.md

File metadata and controls

58 lines (42 loc) · 1.37 KB

Developer Setup Guide

This guide will help you set up the development environment for ColAI on your local machine.

Prerequisites

  • Flutter SDK: >=3.5.0
  • Dart SDK: ^3.5.0
  • Android Studio or VS Code with Flutter extensions installed.
  • Android Device or Emulator: Running API 26 (Android 8.0) or higher.

Installation Steps

  1. Clone the project to your local machine.
  2. Install dependencies: 
    flutter pub get
  3. Run the app on your connected device: 
    flutter run

Build Instructions

Release APK

To build a production-ready universal APK:

flutter build apk --release

Split APKs (Optimized for size)

To build architecture-specific APKs (recommended for distribution):

flutter build apk --split-per-abi

Running Tests

We have a comprehensive test suite for all business logic and state management.

To run all tests:

flutter test

To run a specific test:

flutter test test/sessions_bloc_test.dart

Security Note

This app uses encryption for local storage. The encryption keys are managed by SecureCiphers. During development, the app will generate its own keys locally.

Contribution Policy

Please note: External contributions (Pull Requests) are not accepted. This project is maintained as a personal work under the Apache License 2.0.