79 lines
3.6 KiB
Markdown
79 lines
3.6 KiB
Markdown
|
# Robo-advisory
|
||
|
|
|
||
|
|
## Directory Structure
|
||
|
|
.
|
||
|
|
├── models # Model classes
|
||
|
|
├── providers # Provides for State Management
|
||
|
|
├── screens # APP Screens/Views
|
||
|
|
│ ├── sample screen # Screen separate folder for local widget
|
||
|
|
│ ├── local_widgets
|
||
|
|
│ ├── sample_screen.dart
|
||
|
|
├── services # Front-to-backend methods such as APIs
|
||
|
|
├── widgets # wWdgets used in multiple different views
|
||
|
|
├── utils # Helper Methods
|
||
|
|
├── theme # Theme Configuration
|
||
|
|
├── main.dart # Entry Point
|
||
|
|
└── README.md
|
||
|
|
## Enviroment Setup
|
||
|
|
### Step 1: (Some Basic Steps):
|
||
|
|
- #### Install Homebrew: (Package Manager)
|
||
|
|
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
|
||
|
|
- #### Install GIT
|
||
|
|
brew install git
|
||
|
|
### Step 2: (Setup Android Studio):
|
||
|
|
- #### Download Android Studio
|
||
|
|
The fastest way is to download and install Android Studio.
|
||
|
|
Android Studio is available at:https://developer.android.com/studio/index.html
|
||
|
|
|
||
|
|
- #### Install Android Studio
|
||
|
|
To install Android Studio on your Mac, proceed as follows
|
||
|
|
1. Launch the Android Studio DMG file.
|
||
|
|
2. Drag a nd drop Android Studio into the Applications folder, then launch Android Studio.
|
||
|
|
3. Select whether you want to import previous Android Studio settings, then click OK.
|
||
|
|
4. The Android Studio Setup Wizard guides you though the rest of the setup, which includes downloading Android SDK components that are required for development. Click the Next button.
|
||
|
|
5. Select a Standard installation and click Next.
|
||
|
|
6. On the Verify Settings window, click Finish.
|
||
|
|
Once installed, you get the Welcome to Android Studio window.
|
||
|
|
|
||
|
|
- #### Configure SDK Manager
|
||
|
|
1. In the left pane select Android SDK. On the right pane, select the SDK Platforms Tab and select the SDKs for API level.
|
||
|
|
2. Click the OK button to download and install these Android SDKs.
|
||
|
|
3. After accepting the licence you should see the following screen:
|
||
|
|
Wait until all components are installed
|
||
|
|
|
||
|
|
- #### Setup the ANDROID_HOME system variable
|
||
|
|
1. Open the SDK Manager and make a copy of the Android SDK Location
|
||
|
|
2. Open the Terminal app and type the following command:
|
||
|
|
```export ANDROID_HOME=/Users/HDO/Library/Android/sdk```
|
||
|
|
To check the `ANDROID_HOME` is correctly setup type the following commands:
|
||
|
|
```
|
||
|
|
cd $ANDROID_HOME
|
||
|
|
ls
|
||
|
|
```
|
||
|
|
You should see the following result:
|
||
|
|
```
|
||
|
|
add-ons extras patcher platforms system-images
|
||
|
|
build-tools licenses platform-tools sources tools
|
||
|
|
```
|
||
|
|
|
||
|
|
- #### Persist the ANDROID_HOME system variable for the current user
|
||
|
|
Add Android Studio home path into your `.zsh` or `.bash` profile
|
||
|
|
|
||
|
|
### Step 3: (Install Flutter):
|
||
|
|
1. Download Flutter SDK
|
||
|
|
2. Add the flutter tool to your path
|
||
|
|
|
||
|
|
For SDK and instructions: https://flutter.dev/docs/get-started/install/macos
|
||
|
|
|
||
|
|
### Step 4: (Install the Flutter and Dart plugins):
|
||
|
|
To install these:
|
||
|
|
1. Start Android Studio.
|
||
|
|
2. Open plugin preferences (Preference -> Plugins -> Search (Flutter) [Author: Flutter.dev]).
|
||
|
|
3. Click Yes when prompted to install the Dart plugin and restart.
|
||
|
|
|
||
|
|
### Step 4: (Clone Porject):
|
||
|
|
- Clone Project Using Git command line tool:
|
||
|
|
|
||
|
|
git clone git@github.com:Octek/Robo-advisory.git robo_advisory
|
||
|
|
cd robo_advisory
|