Installation
============

.. autosummary::
   :toctree: generated


Developer installation
----------------------

In order to install and get the app running on your machine, clone the repository from GitHub and follow the installation steps listed in the README file.

Prerequisites
^^^^^^^^^^^^^

- Flutter SDK
- Python
- Pip (Python package manager)

Instructions for installing Flutter can be found `here <https://docs.flutter.dev/install>`_.

Backend
"""""""

1. Navigate to the backend directory: ::
      
      cd backend

2. Install Python dependencies: ::
   
      python -m pip install -r requirements.txt

3. Run the Flask server: ::
   
      python server.py

Frontend
""""""""

1. Navigate to the frontend directory: ::
   
      cd frontend
2. Install Flutter dependencies: ::
   
      flutter pub get
3. Run the Flutter app: ::
   
      flutter run


User installation
-----------------

Users can install the app by downloading a pre-packaged APK.