diff --git a/docs/source/Project/benchmark.rst b/docs/source/Project/benchmark.rst index d82cbf9..e6d16d3 100644 --- a/docs/source/Project/benchmark.rst +++ b/docs/source/Project/benchmark.rst @@ -86,6 +86,8 @@ Mobile: Flutter - **Performance**: Near-native performance due to Dart compiling to native machine code. - **Customizable UI**: Powerful widgets for designing complex UIs. - **Fast Development**: Hot reload and an extensive library of plugins. +- **Comprehensive Documentation**: Detailed and well-maintained documentation, making it easy to learn and use. +- **Familiarity**: Already comfortable with the technology, speeding up development and reducing the learning curve. **Comparisons**: @@ -110,7 +112,7 @@ Mobile: Flutter - Native-specific **Conclusion**: -Flutter’s cross-platform capabilities and performance make it ideal for quickly developing a polished mobile app. +Flutter’s cross-platform capabilities, performance, and comprehensive widget library make it ideal for quickly developing a polished mobile app. Server: Go ----------- diff --git a/docs/source/client_mobile/index.rst b/docs/source/client_mobile/index.rst index 2ca73b3..91f5839 100644 --- a/docs/source/client_mobile/index.rst +++ b/docs/source/client_mobile/index.rst @@ -8,7 +8,7 @@ Welcome to the AREA Client Mobile documentation! Overview -------- -The AREA Client Mobile is the mobile application part of the AREA project, built using React Native and TypeScript. It provides a user-friendly interface for setting up and managing automated workflows that integrate various services on mobile devices. +The AREA Client Mobile is the mobile application part of the AREA project, built using Flutter and Dart. It provides a user-friendly interface for setting up and managing automated workflows that integrate various services on mobile devices. Key Features ------------ diff --git a/docs/source/client_mobile/installation.rst b/docs/source/client_mobile/installation.rst index 5b1b0a6..54a9b75 100644 --- a/docs/source/client_mobile/installation.rst +++ b/docs/source/client_mobile/installation.rst @@ -1,7 +1,20 @@ +Follow these steps to set up and run the AREA Client Mobile project. + Installation ============ -Follow these steps to set up and run the AREA Client Web project. +Prerequisites +---------- + +Before you start, make sure your development environment is correctly configured: + +1. **Flutter**: Install Flutter on your machine. Follow the official instructions at `flutter.dev `_. +2. **Android Studio or Xcode**: + - For Android, install Android Studio with the necessary tools (Android SDK, AVD). + - For iOS, install Xcode (requires macOS). +3. **Git**: Make sure Git is installed to clone the repository. +4. **Test device**: + - An emulator (iOS or Android) or a connected physical device. 1. Clone the repository ----------------------- @@ -10,22 +23,17 @@ Follow these steps to set up and run the AREA Client Web project. git clone git@github.com:ASM-Studios/AREA.git -2. Install NPM packages +2. Install Flutter packages ----------------------- .. code-block:: sh - cd AREA/client_web - npm install + cd AREA/client_mobile + flutter pub get 3. Run the project ------------------ .. code-block:: sh - npm run start - -4. Access the application -------------------------- - -To get the .apk, go onto the front-end and navigate to the following URL: https://localhost:8081/client.apk + flutter run