### Directory Structure:

| BillmaxApp | BillmaxApp |
| ---------- | ------------------- |
| Flutter | Billmax-Main |
| | Billmax_Technicians |

### Getting things running...

First set up your text editor using Flutter's [instructions](https://docs.flutter.dev/get-started/editor).

> It may say having trouble finding the Flutter SDK. In that case, click the "Locate SDK" button and navigate your file structure to select the Flutter folder.

You can then drag and drop your `Billmax_Technicians` folder onto the vscode screen to open it up. To open a terminal, go to `Terminal` along the top, then new terminal.

1. `cd` into `BillmaxApp` (maybe need to get there from `cd ..`)
2. run ``export PATH="$PATH:`pwd`/flutter/bin"``
3. `cd` into `Billmax-Main`
4. `cd` into `Billmax_Technicians`
5. run `open -a Simulator` or, go to `Xcode -> Xcode -> Developer Tools -> Simulator`
6. run `flutter run`

#### Using Flutter Commands with the Simulator
1. `q` will quit the app
2. `r` will refresh it
3. `R` will reload the whole app (use this to get back to the login)
4. `p` opens up the debug inspector

## Installing GIT and Github

1. First install `Git`:
- `brew install git` in any terminal window. Doesn't matter where.
2. Go to [Github](https://github.com/). Github just shows you all your **repositories** (programming projects) in an online space.
- Follow the steps to make and setup an account.
3. Give me your username. I'll add you to the `Billmax` repository.
- This will send you an email.
4. Once you are in the repository, click the **green** `code` button, and click the `copy` icon next to the link.
5. In the `BillmaxApp` folder, **delete** Billmax-Main.
6. Use the terminal to `cd` into `BillmaxApp` folder. Start the command with `git clone`. Then `command + v` to paste the link you copied from the github website. So, the whole command would look like `git clone https://somewebaddressfromgithub.com` **This will put all the code into that folder, and make it a place where you can continue to update and pull code.**
7. Follow commands up above to start up simulator.

## Using Github
1. When you are `cd`'ed into the `billmax_technicians` folder, at any point you can use the command in the terminal `git pull`, this will take everything from the online version, and update it
- **IMPORTANT NOTE** do not make any changes to the files when working with git unless you want to reconcile the differences. If you make changes to the files and then do `git pull`, github freaks out a little
- The idea is that, really you should be pushing your changes to the remote repository when you make them, then the other person can pull... etc, but because I probably don't want any "playing around" changes overwriting my code, this isn't good

## Starting up XCode
1. Open the app, (might have to use the spotlight search at the top bar of the mac to see it)
2. Open up the `runner` project from the list on the right hand side that has the billmax information
3. Plug in your device. ensure it is on, *and unlocked* throughout this.
4. At the top grey bar with the little white logo and the word `runner`, click the text and from the dropdown, select your phone (should have your name or something)
5. Wait for the right hand side of the bar to say it is ready
6. Click on the white "Play" button on the top left of the screen to get the app running