Merge pull request #83 from CityOfLosAngeles/readme-update1

Update README.md, LATESTS 4.15.2024

README.md

@@ -1,10 +1,36 @@
-# Angeleno - Profile
+# Angeleno - My Account
 <a href="https://github.com/CityOfLosAngeles/angeleno-my-account-flutter/actions"><img src="https://github.com/CityOfLosAngeles/angeleno-my-account-flutter/workflows/Dart%20Analyzer/badge.svg" alt="Dart Analyzer Status"></a>
 <a href="https://github.com/CityOfLosAngeles/angeleno-my-account-flutter/actions"><img src="https://github.com/CityOfLosAngeles/angeleno-my-account-flutter/workflows/Flutter%20Unit%20Tests/badge.svg" alt="Flutter Tests Status"></a>
 [![codecov](https://codecov.io/gh/CityOfLosAngeles/angeleno-my-account/graph/badge.svg?token=ILNR5XOM40)](https://codecov.io/gh/CityOfLosAngeles/angeleno-my-account)
 
+## What is an Angeleno Account?
+An Angeleno Account acts as a single sign-on for our public to access multiple City of Los Angeles services that have integrated Angeleno Account SSO login. 
+
+## What is this Repository (Angeleno - My Account)?
+This repository is a Flutter based web-app that interfaces with Auth0 to handle user authentication and allows users to edit their Angeleno Account profile and their account security via multi-factor authentication.
+
 ## Getting Started
-This branch should act as our main branch until we have a working Minimum Viable Product (MVP) to merge into the `main` branch. To start development you'll `git clone` this repo; after cloning you'll by default be on the main branch, but you can `git checkout mvp-skeleton` to switch to the branch with the code being worked on. From the `mvp-skeleton` branch, you can branch off to work on your own work/issue by running `git checkout -b your-branch-name`. When opening the pull request for your work, make sure the branch is being merged into `mvp-skeleton` and not `main`.
+The development branch is our main branch you can use to work on your own work/issues. To start development you'll `git clone` this repo; after cloning you'll by default be on the development branch. When opening the pull request for your work, make sure the branch is being merged into `development` branch as well.
+
+### Minimum Requirements
+- [Flutter](https://docs.flutter.dev/get-started/install) >= 3.16.0
+- [Node](https://nodejs.org/en/download)
+- [Firebase Local Emulator Suite](https://firebase.google.com/docs/emulator-suite)
+- [Google Cloud Account](https://cloud.google.com/)
+  - Create Project and enable the following APIs:
+    - [Places Autocomplete](https://developers.google.com/maps/documentation/places/web-service/autocomplete) 
+    - [Places Details](https://developers.google.com/maps/documentation/places/web-service/details)
+    - [Service Usage](https://cloud.google.com/service-usage/docs/overview)
+    - [Firebase](https://firebase.google.com/)
+    - [Cloud Resource Manager](https://cloud.google.com/resource-manager)
+    - [Secret Manager](https://cloud.google.com/security/products/secret-manager) 
+    - [Compute Engine](https://cloud.google.com/products/compute)
+
+- [Auth0 Account](https://auth0.com/docs/get-started)
+  - Create 2 Auth0 Apps:
+    - Single Page App for authenticating sessions used for the Flutter Auth0Web library
+    - Regular Web App for handling transactions with Auth0's API's (MFA, password changes, and writing user updates to Auth0)   
+
 
 ## Development
 
@@ -14,13 +40,13 @@ After downloading the [Flutter SDK](https://docs.flutter.dev/get-started/install
 
 Making updates to `.dart` files will require you to run `flutter build web` so that the web app can recompile.
 
-After building, you can use `flutter run -d chrome` to run on Chrome. You can add additional devices (browsers) for additional testing.
+After building, you can use `flutter run -d chrome` to run on Chrome. You can add additional devices (browsers) for cross-browser testing.
 
 If you need to specify a web port to run the app on, you can append the argument `--web-port=####` to the above - this will be helpful when testing redirects from external apps as it'll allow us to control a designated port.
 
 In order for the code to pick your environment variables, you'll have to append `--dart-define-from-file=.env` to your flutter run command.
 
-Running `flutter analyze` will check your code to make sure it aligns with our linting rules.
+On windows, you can run `.\tests.bat`, which will run both `dart analyze` to check linting and `flutter test` to run unit tests.
 
 ### Local Development
 Rename the `.env-example` file to `.env` and fill in the required environment variables.
@@ -29,4 +55,15 @@ In Auth0, you'll want to create a Single Page Application to get the appropriate
 
 If you're using a cloud function without authorization, you will not need the Service Account variables, but the code will have to be modified.
 
-The cloud functions being used can be found in the `functions` directory. To run them locally, you can find instructions [here](https://firebase.google.com/docs/functions/local-emulator). Once you have the functions running locally, you'll have to update the code in the locations where the request is sent so that it points to your emulator.
+The cloud functions being used can be found in the `functions` directory. To run them locally, you can find instructions [here](https://firebase.google.com/docs/functions/local-emulator). Once you have the functions running locally, you'll have to update the code in the locations (e.g. [here](/lib/controllers/api_implementation.dart#L88)) where the request is sent so that it points to your emulator.
+
+#### Commands
+Needed for running project:
+- flutter run -d chrome --web-port=#### --dart-define-from-file=.env
+- firebase emulators:start --only functions
+
+Needed for syntax:
+- dart analyze
+
+Needed for running Unit Tests:
+- flutter test