Merge pull request #51 from ASM-Studios/mra/feat-sphinx-docs

docs(sphinx): add base doc for all project component

client_web/package.json

@@ -5,6 +5,7 @@
   "type": "module",
   "main": "electron.js",
   "scripts": {
+    "start": "mkcert -install && mkcert localhost && vite",
     "dev": "mkcert -install && mkcert localhost && vite",
     "production": "vite --mode production",
     "build": "tsc -b && vite build",

doc/source/client_mobile/index.rst

@@ -0,0 +1,31 @@
+.. AREA Client Mobile Documentation
+
+AREA Client Mobile
+==================
+
+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.
+
+Key Features
+------------
+
+- **User Authentication**: Secure login and registration using various authentication providers.
+- **Responsive Design**: Optimized for various mobile devices.
+- **Customizable Workflows**: Create and manage workflows with ease.
+
+Getting Started
+---------------
+
+To get started with the AREA Client Mobile, follow the installation and setup instructions in the :doc:`installation` section.
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   installation

doc/source/client_mobile/installation.rst

@@ -0,0 +1,31 @@
+Installation
+============
+
+Follow these steps to set up and run the AREA Client Web project.
+
+1. Clone the repository
+-----------------------
+
+.. code-block:: sh
+
+    git clone [email protected]:ASM-Studios/AREA.git
+
+2. Install NPM packages
+-----------------------
+
+.. code-block:: sh
+
+    cd AREA/client_web
+    npm install
+
+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