Skip to content

Commit

Permalink
feat(doc_mobile): updated installation instructions and mobile benchmark
Browse files Browse the repository at this point in the history
  • Loading branch information
sambrus committed Nov 27, 2024
1 parent 4215bdb commit 91e2abf
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 12 deletions.
4 changes: 3 additions & 1 deletion docs/source/Project/benchmark.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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**:

Expand All @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/source/client_mobile/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down
28 changes: 18 additions & 10 deletions docs/source/client_mobile/installation.rst
Original file line number Diff line number Diff line change
@@ -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 <https://flutter.dev/docs/get-started/install>`_.
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
-----------------------
Expand All @@ -10,22 +23,17 @@ Follow these steps to set up and run the AREA Client Web project.
git clone [email protected]: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

0 comments on commit 91e2abf

Please sign in to comment.