Getting Started

Tools Using

1. Visual Studio Code
2. Ionic
3. Vue
4. TypeScript

---

Dev Install Instructions

1. Install Node.js Here
2. Install Android Studio Here (Optional, this for running an Android emulator)

Command Line Setup

1. Open the command prompt and enter the following commands:

   • Install Vue

     npm install -g @vue/cli

   • Install Ionic and Capacitor

     npm install -g @ionic/cli @capacitor/assets

2. Navigate to the desired directory:

   • Clone the repository

     git clone https://github.com/Sanmeet-EWU/cscd-488-490-project-save-farmers/tree/main/Source/savefarmer.git savefarmer

   • Change to the project directory and run the app

     cd savefarmer && npm install && ionic serve

   (This command should open the app in your browser. If it doesn't, ensure Vue and Ionic are installed correctly.)

Code Editing

You can now open the entire folder with a code editor such as VS Code (make sure to have the Vue, TypeScript, and Ionic extensions installed) to edit the code within the src folder.

Third Party Plugins

The following are third party plugins that you will need to run the app:

• Chart.js

  npm install chart.js

• chartjs-plugin-datalabels

  npm install chartjs-plugin-datalabels

  OR

  yarn add chartjs-plugin-datalabels

---

Emulator Instructions

1. In the project terminal, run the following commands:
   Ensure Android Studio is installed and open during the first run to build properly.

   • Add Capacitor Android files

     ionic cap add android

   • Build Android

     ionic cap build android

     (This should open Android Studio and build the emulator)

   • Run the Emulator

     ionic cap run

     (This should launch the emulator. Note: It may take some time.)

---

Cypress Testing Instructions

Prerequisites:

1. Verify Cypress is installed:

   npm install cypress

2. Ensure that the development server is running before starting Cypress:

   npm run dev

By default, this serves the app at http://localhost:5173. You can change the base port in cypress.config.ts to match your local machine.

3. Run tests with Cypress:

   npm run test:e2e

4. Navigate to navigation.spec.ts to modify/view tests:

   cd savefarmer/tests/e2e/specs/navigation.spec.ts

Database Setup (Sqlite with Capacitor):

You can find all the information at this Github and in this VIDEO

1. Install Capacitor:

   npm run build  
   npm install --save @capacitor-community/sqlite
   npx cap sync

2. Install Capacitor (Option #2);

   npm install --global yarn
   yarn add @capacitor-community/sqlite
   npx cap sync