From 568eb95791c78c9762ca0ecdcab871368cda3340 Mon Sep 17 00:00:00 2001
From: Priya Power <49959312+priyapower@users.noreply.github.com>
Date: Mon, 23 Sep 2024 12:30:47 -0500
Subject: [PATCH 1/5] Add readme from prototype with sections for new docs

---
 README.md                                 | 425 +++++++++++++++++++++-
 apps/rufferal/src/app/screens/Screens.tsx |   3 +-
 2 files changed, 415 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 4456d61..bba5870 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,420 @@
-# RufferalFrontend
+# Rufferal Frontend
+
+blarg
+
+Things to think about
+
+- graphql
+- error handling
+- security handling
+- unit testing
+- integration testing
+- e2e testing
+- deployment
+- env vars and secrets
+- deployment
+- other developer nice to haves
+
+## Device Support
+_coming soon_
+
+### List of devices
+_coming soon_
+
+### Mobile/Web mobile Viewport sizes
+
+- Designed for mobile displays from 320×568 through 430×1004
+- Primary test devices
+  - ANDROID
+    - Galaxy S8
+    - 360 x 740
+  - IOS
+    - iPhone X
+    - 375 x 812
+- Smallest test devices
+  - ANDROID
+    - Galaxy S7
+    - 360 x 640
+  - IOS
+    - iPhone 5/SE
+    - 320 x 568
+- Largest test devices
+  - ANDROID
+    - Galaxy Z Flip 5
+    - 412 x 1004
+  - IOS
+    - iPhone 15 Pro Max
+    - 430 x 932
+
+### Tablet Viewport sizes
+_coming soon_
+
+### Desktop Viewport sizes
+_coming soon_
+
+## Themes
+_coming soon_
+
+## Installation
+_coming soon_
+
+## (PROTOTYPE) Themes
+
+### Colors
+
+- PRIMARY (slate gray)
+  - ORIGINAL
+    - #667080
+  - TAILWIND TRANSLATION (until custom colors are handled)
+    - #6b7280
+    - `bg-gray-500`
+      - `text-white` [pairing]
+    - `border-gray-500`
+    - `text-gray-500`
+- SECONDARY (light slate gray)
+  - ORIGINAL
+    - #EEF1F4
+  - TAILWIND TRANSLATION (until custom colors are handled)
+    - #cbd5e1
+    - `bg-slate-200`
+      - `text-gray-500` [pairing]
+      - `text-zinc-300` [pairing]
+    - `border-slate-200`
+    - `text-slate-200`
+- TERTIARY (dark gray)
+  - ORIGINAL
+    - #252529
+  - TAILWIND TRANSLATION (until custom colors are handled)
+    - #18181b
+    - `bg-zinc-900`
+      - `text-white` [pairing]
+    - `border-zinc-900`
+    - `text-zinc-900`
+- QUATERNARY (gray)
+  - ORIGINAL
+    - #8A8A8F
+  - TAILWIND TRANSLATION (until custom colors are handled)
+    - _used for icon tint_
+    - #71717a
+    - `bg-zinc-500`
+      - `text-zinc-900` [pairing]
+    - `border-zinc-500`
+    - `text-zinc-500`
+- DISABLED (light gray)
+  - ORIGINAL
+    - #C8C7CC
+  - TAILWIND TRANSLATION (until custom colors are handled)
+    - _used for text color_
+    - #d4d4d8
+    - `text-zinc-300`
+    - `bg-zinc-300`
+      - `text-white` [pairing]
+      - `text-gray-500` [pairing]
+    - `border-zinc-300`
+- NEUTRALS
+  - black
+    - #000
+    - `bg-black`
+    - `border-black`
+    - `text-black`
+  - white
+    - #fff
+    - `bg-white`
+    - `border-white`
+    - `text-white`
+
+## (PROTOTYPE) Install
+
+Setup assumes you have a MacOS
+
+### Prereqs
+
+- [Homebrew](https://brew.sh/)
+
+  ```shell
+  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+  ```
+
+- npm and node
+
+  ```shell
+  brew install node
+  node -v
+  npm -v
+  ```
+
+- watchman
+
+  ```shell
+  brew install watchman
+  ```
+
+- NX
+
+  ```shell
+  npm install -g nx
+  ```
+
+- Java Development Kit
+
+  ```shell
+  brew install --cask zulu@17
+  ```
+
+  - After the JDK installation, update `~/.zshrc` (or in `~/.bash_profile`)
+    - Get path to where cask was installed to double-click installer (probably located at `/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home`)
+    ```shell
+    brew info --cask zulu@17
+    ```
+    - Add or update your JAVA_HOME environment variable to `.zshrc`
+    ```bash
+    # Update with appropriate path on your local
+    export JAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home
+    ```
+
+- [Android Studio](https://developer.android.com/studio)
+
+  - Download and setup
+  - While on Android Studio installation wizard, make sure the boxes next to all of the following items are checked:
+    - Android SDK
+    - Android SDK Platform
+    - Android Virtual Device
+
+- Android SDK
+
+  - Open Android Studio
+  - Click on "More Actions" button and select "SDK Manager"
+    - The SDK Manager can also be found within the Android Studio "Settings" dialog, under Languages & Frameworks → Android SDK
+  - Select the "SDK Platforms" tab from within the SDK Manager
+  - Check the box next to "Show Package Details" in the bottom right corner
+  - Look for and expand the Android 14 (UpsideDownCake) entry
+  - Make sure the following items are checked:
+    - Android SDK Platform 34
+    - Intel x86 Atom_64 System Image or Google APIs Intel x86 Atom System Image or (for Apple M1 Silicon) Google APIs ARM 64 v8a System Image
+  - Next, select the "SDK Tools" tab
+  - Check the box next to "Show Package Details" here as well
+  - Look for and expand the "Android SDK Build-Tools" entry
+  - Make sure that 34.0.0 is selected
+  - Finally, click "Apply" to download and install the Android SDK and related build tools
+
+- Android env variable
+
+  - Add the following lines to your `~/.zprofile` or `~/.zshrc` (if you are using bash, then `~/.bash_profile` or `~/.bashrc`) config file:
+
+  ```bash
+  export ANDROID_HOME=$HOME/Library/Android/sdk
+  export PATH=$PATH:$ANDROID_HOME/emulator
+  export PATH=$PATH:$ANDROID_HOME/platform-tools
+  ```
+
+- Android [AVD](https://developer.android.com/studio/run/managing-avds.html)
+
+  - Open Android Studio
+  - Setup a virtual device
+    - Create a new AVD
+    - Select "Create Virtual Device..."
+    - Then pick any Phone from the list (I like to select the smallest phone to start with)
+    - Click "Next"
+    - Select the `UpsideDownCake API Level 34` image
+      - If it is not selectable, select the download icon
+    - Click "Next" then "Finish" to create your AVD
+    - At this point you should be able to click on the green triangle button next to your AVD to launch it (though we don't have a project yet)
+
+- [XCode](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
+
+  - Download and setup
+    - Select options for laptop/desktop and ios/iphone development
+  - Setup command line tools (do not use terminal commands - this can messup your setup)
+    - Open Xcode
+    - Choose Settings... (or Preferences...) from the Xcode menu
+    - Go to the Locations panel
+    - Install the tools by selecting the most recent version in the Command Line Tools dropdown
+
+- Pod
+
+  ```shell
+  gem install cocoapods
+  ```
+
+### Clone the repository
+
+```shell
+git clone git@github.com:Ruffrl/rufferal-frontend.git
+cd rufferal-frontend
+```
+
+### Install dependencies
+
+- Desktop/mobile-web
+
+  ```shell
+  npm install
+  nx run store:build
+  nx run webApp:build
+  ```
+
+- Android
+
+  ```shell
+  nx run rufferal:build-android
+  ```
+
+- Build ios
+
+  ```shell
+  nx run rufferal:build-ios
+  ```
+
+  If this fails, try:
+
+  ```shell
+  cd apps/rufferal
+  bundle
+  cd ios
+  pod install
+  cd ../..
+  nx run rufferal:build-ios
+  ```
+
+  ```shell
+  cd apps/rufferal && bundle && cd ios && pod install && cd ../../..
+  nx run rufferal:build-ios
+  ```
+
+### Serve
+
+- Backend server required to interact with frontend app
+
+  - [Backend setup](https://github.com/Ruffrl/rufferal-backend?tab=readme-ov-file#install)
+
+- Launch desktop/mobile-web
+
+  ```shell
+  npx nx serve webApp
+  ```
+
+  - Visit http://localhost:3000 to see test app
+
+- Launch android
+
+  - Open Android Studio
+  - Launch any virtual device (you can load the frontend project, or apps/rufferal or apps/rufferal/android - your choice)
+
+  ```shell
+  npx nx run rufferal:start
+
+  # In a seperate terminal
+  npx nx run rufferal:run-android
+
+  # If Android needs a bundle/build reset
+  cd apps/rufferal/android
+  ./gradlew clean
+  ./gradlew wrapper
+  ./gradlew bundleRelease
+
+  # Manually bundle
+  cd apps/rufferal
+  npx react-native bundle --platform android --dev false --reset-cache --entry-file src/main.tsx --bundle-output android/app/build/generated/assets/createBundleReleaseJsAndAssets/index.android.bundle
+
+  # With Assets
+  cd apps/rufferal
+  npx react-native bundle --platform android --dev false --reset-cache --entry-file src/main.tsx --bundle-output android/app/build/generated/assets/createBundleReleaseJsAndAssets/index.android.bundle --assets-dest android/app/src/main/res
+
+  cd apps/rufferal && npx react-native bundle --platform android --dev false --reset-cache --entry-file src/main.tsx --bundle-output android/app/build/generated/assets/createBundleReleaseJsAndAssets/index.android.bundle --assets-dest android/app/src/main/res && cd ../..
+  ```
+
+  - The Rufferal app should launch within the Android Studio virtual device!
+  - If this launched a separate Simulator, you can technically close Android Studio if you want
+
+- Launch ios
+
+  - Open Xcode
+  - Load apps/rufferal/ios
+
+  ```shell
+  npx nx run rufferal:start
+
+  # In a seperate terminal
+  npx nx run rufferal:run-ios
+  ```
+
+  - An Emulator should launch with ios and contain Rufferal app!
+  - If this launched a separate Simulator, you can technically close XCode if you want
+
+---
+
+### Original NX Notes
+
+#### Integrate with editors
+
+Enhance your Nx experience by installing [Nx Console](https://nx.dev/nx-console) for your favorite editor. Nx Console
+provides an interactive UI to view your projects, run tasks, generate code, and more! Available for VSCode, IntelliJ and
+comes with a LSP for Vim users.
+
+#### Start the application
+
+Run `npx nx serve rufferal` to start the development server. Happy coding!
+
+#### Build for production
+
+Run `npx nx build rufferal` to build the application. The build artifacts are stored in the output directory (e.g. `dist/` or `build/`), ready to be deployed.
+
+#### Running tasks
+
+To execute tasks with Nx use the following syntax:
+
+```
+npx nx <target> <project> <...options>
+```
+
+You can also run multiple targets:
+
+```
+npx nx run-many -t <target1> <target2>
+```
+
+..or add `-p` to filter specific projects
+
+```
+npx nx run-many -t <target1> <target2> -p <proj1> <proj2>
+```
+
+Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/features/run-tasks).
+
+#### Set up CI!
+
+Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further.
+
+- [Set up remote caching](https://nx.dev/features/share-your-cache)
+- [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution)
+- [Learn more how to setup CI](https://nx.dev/recipes/ci)
+
+#### Explore the project graph
+
+Run `npx nx graph` to show the graph of the workspace.
+It will show tasks that you can run with Nx.
+
+- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph)
+
+#### Connect with us!
+
+- [Join the community](https://nx.dev/community)
+- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools)
+- [Follow us on Twitter](https://twitter.com/nxdevtools)
+
+## NX Notes
 
 <a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
 
 ✨ Your new, shiny [Nx workspace](https://nx.dev) is almost ready ✨.
 
-[Learn more about this workspace setup and its capabilities](https://nx.dev/nx-api/expo?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed!
+[Learn more about this workspace setup and its capabilities](https://nx.dev/nx-api/expo?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed!
 
-## Finish your CI setup
+### Finish your CI setup
 
 [Click here to finish setting up your workspace!](https://cloud.nx.app/connect/FWnkRYuUP7)
 
-
-## Run tasks
+### Run tasks
 
 To run the dev server for your app, use:
 
@@ -30,12 +433,12 @@ To see all available targets to run for a project, run:
 ```sh
 npx nx show project rufferal
 ```
-        
+
 These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files.
 
 [More about running tasks in the docs &raquo;](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
 
-## Add new projects
+### Add new projects
 
 While you could add new projects to your workspace manually, you might want to leverage [Nx plugins](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) and their [code generation](https://nx.dev/features/generate-code?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) feature.
 
@@ -57,25 +460,25 @@ You can use `npx nx list` to get a list of installed plugins. Then, run `npx nx
 
 [Learn more about Nx plugins &raquo;](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | [Browse the plugin registry &raquo;](https://nx.dev/plugin-registry?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
 
-
 [Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
 
-## Install Nx Console
+### Install Nx Console
 
 Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.
 
 [Install Nx Console &raquo;](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
 
-## Useful links
+### Useful links
 
 Learn more:
 
-- [Learn more about this workspace setup](https://nx.dev/nx-api/expo?utm_source=nx_project&amp;utm_medium=readme&amp;utm_campaign=nx_projects)
+- [Learn more about this workspace setup](https://nx.dev/nx-api/expo?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
 - [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
 - [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
 - [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
 
 And join the Nx community:
+
 - [Discord](https://go.nx.dev/community)
 - [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl)
 - [Our Youtube channel](https://www.youtube.com/@nxdevtools)
diff --git a/apps/rufferal/src/app/screens/Screens.tsx b/apps/rufferal/src/app/screens/Screens.tsx
index d4daffc..1e7d6fb 100644
--- a/apps/rufferal/src/app/screens/Screens.tsx
+++ b/apps/rufferal/src/app/screens/Screens.tsx
@@ -23,7 +23,6 @@ export const Screens = observer(() => {
     <NavigationContainer>
       <Stack.Navigator screenOptions={{ headerShown: false }}>
         {/* ⬇️⬇️⬇️ CURRENT DEVELOPMENT PAGE ⬇️⬇️⬇️ */}
-        <Stack.Screen name="Dog Careplan" component={DogCareplanScreen} />
         {/* ⬆️⬆️⬆️ CURRENT DEVELOPMENT PAGE ⬆️⬆️⬆️ */}
 
         <Stack.Screen
@@ -38,7 +37,7 @@ export const Screens = observer(() => {
         <Stack.Screen name="Dog Details" component={DogDetailsScreen} />
         <Stack.Screen name="Dog Avatar" component={DogAvatarScreen} />
         <Stack.Screen name="Dog Personality" component={DogPersonalityScreen} />
-        {/* <Stack.Screen name="Dog Careplan" component={DogCareplanScreen} /> */}
+        <Stack.Screen name="Dog Careplan" component={DogCareplanScreen} />
         <Stack.Screen name="Search" component={SearchScreen} />
 
         <Stack.Screen name="Camera" component={CameraScreen} />

From ff40c692df5ec7e0569637d82dee02c980c6be81 Mon Sep 17 00:00:00 2001
From: Priya Power <49959312+priyapower@users.noreply.github.com>
Date: Mon, 23 Sep 2024 13:34:45 -0500
Subject: [PATCH 2/5] Fix exports

---
 README.md                                     | 87 +++++++++++++++++--
 ui/src/components/atoms/button/button.tsx     |  2 +-
 .../field-input-area/field-input-area.tsx     |  2 +-
 .../atoms/field-input/field-input.tsx         |  2 +-
 .../atoms/field-select/field-select.tsx       |  4 +-
 ui/src/components/index.ts                    |  2 +-
 ui/src/components/molecules/index.ts          |  4 +-
 .../cats/cat-personality/cat-personality.tsx  |  2 +-
 .../dogs/dog-personality/dog-personality.tsx  |  2 +-
 .../pets/create/pet-careplan-options.tsx      |  2 +-
 .../pages/pets/manage-pets/manage-pets.tsx    |  2 +-
 .../profiles/create/pet-splash/pet-splash.tsx |  2 +-
 12 files changed, 93 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index bba5870..82ad6dc 100644
--- a/README.md
+++ b/README.md
@@ -15,13 +15,13 @@ Things to think about
 - deployment
 - other developer nice to haves
 
-## Device Support
-_coming soon_
+## Device support
 
-### List of devices
-_coming soon_
+- IOS (versions _coming soon_ and above)
+- Android (versions _coming soon_ and above)
+- mobile-web and desktop _coming soon_
 
-### Mobile/Web mobile Viewport sizes
+### Mobile/web mobile viewport sizes
 
 - Designed for mobile displays from 320×568 through 430×1004
 - Primary test devices
@@ -46,17 +46,88 @@ _coming soon_
     - iPhone 15 Pro Max
     - 430 x 932
 
-### Tablet Viewport sizes
+### Tablet viewport sizes
+
 _coming soon_
 
-### Desktop Viewport sizes
+### Desktop viewport sizes
+
 _coming soon_
 
 ## Themes
+
 _coming soon_
 
 ## Installation
-_coming soon_
+
+### How this app was setup
+
+1. Create a new NX app with expo
+
+   ```bash
+   npx create-nx-workspace@latest --preset=expo --appName=rufferal
+
+   ✔ Where would you like to create your workspace? · rufferal-frontend
+   ✔ Test runner to use for end to end (E2E) tests · cypress
+   ✔ Which CI provider would you like to use? · github
+   ```
+
+2. Create libraries
+
+   ```bash
+   # UI LIBRARY
+   npx nx generate @nx/expo:lib ui
+     # I added my personal UI setup that follows "Atomic Design" methodologies
+
+   # ASSETS
+   npx nx generate @nx/expo:lib assets
+
+   # STORE (currently MobX)
+   npx nx generate @nx/expo:lib store
+
+   # UTILS
+   npx nx generate @nx/expo:lib utils
+
+   # STYLES CONFIGURATION (currently Tailwind)
+   npx nx generate @nx/expo:lib tailwind
+     # Chose to use explicit naming instead of generic naming because most of the work in this library will be unique to Tailwind configuration
+     # For custom tailwind configurations and branding/theme alignment
+   ```
+
+3. Name libraries accordingly
+
+   In `tsconfig.base.json`:
+
+   ```json
+   {
+     ...
+     "paths": {
+         "@rufferal/assets/*": ["assets/*"],
+         "@rufferal/store": ["store/src/index.ts"],
+         "@rufferal/tailwind": ["tailwind/src/index.ts"],
+         "@rufferal/ui": ["ui/src/index.ts"],
+         "@rufferal/utils": ["utils/src/index.ts"]
+       }
+   }
+   ```
+
+4. Generate components
+
+```bash
+nx g @nx/expo:component bottomsheet --directory ui/src/components/atoms/bottomsheet --nameAndDirectoryFormat=as-provided --export=false
+
+# Updates
+#   - Convert component to arrow component without a default export
+#   - Export component from directory
+#   - 
+#   - 
+```
+
+Personally, I ended up not using the component generator as it currently is
+
+- I would like to setup a component generator that applies my system/library expectations
+  - Creates functional (arrow) components instead of default exported normal function componets
+  - exports to local component folder (if in atoms, export is in ./atoms/index.ts, etc)
 
 ## (PROTOTYPE) Themes
 
diff --git a/ui/src/components/atoms/button/button.tsx b/ui/src/components/atoms/button/button.tsx
index 600dbad..feea782 100644
--- a/ui/src/components/atoms/button/button.tsx
+++ b/ui/src/components/atoms/button/button.tsx
@@ -12,7 +12,7 @@ import {
   Text,
   View,
 } from 'react-native';
-import { ButtonType, FieldSize, FieldState } from '../types/field-types';
+import { ButtonType, FieldSize, FieldState } from '..';
 
 interface Props extends PressableProps {
   loading?: boolean;
diff --git a/ui/src/components/atoms/field-input-area/field-input-area.tsx b/ui/src/components/atoms/field-input-area/field-input-area.tsx
index 1eab065..cd4c521 100644
--- a/ui/src/components/atoms/field-input-area/field-input-area.tsx
+++ b/ui/src/components/atoms/field-input-area/field-input-area.tsx
@@ -6,7 +6,7 @@ import {
 } from '@rufferal/utils';
 import { Image } from 'expo-image';
 import { Platform, TextInput, TextInputProps, View } from 'react-native';
-import { FieldSize, FieldState } from '../types/field-types';
+import { FieldSize, FieldState } from '..';
 
 export interface FieldInputAreaProps extends Omit<TextInputProps, 'onChange'> {
   onSubmit?: () => void;
diff --git a/ui/src/components/atoms/field-input/field-input.tsx b/ui/src/components/atoms/field-input/field-input.tsx
index 3702724..7ef1217 100644
--- a/ui/src/components/atoms/field-input/field-input.tsx
+++ b/ui/src/components/atoms/field-input/field-input.tsx
@@ -6,7 +6,7 @@ import {
 } from '@rufferal/utils';
 import { Image } from 'expo-image';
 import { Platform, TextInput, TextInputProps, View } from 'react-native';
-import { FieldSize, FieldState } from '../types/field-types';
+import { FieldSize, FieldState } from '..';
 
 export interface FieldInputProps extends TextInputProps {
   onSubmit?: () => void;
diff --git a/ui/src/components/atoms/field-select/field-select.tsx b/ui/src/components/atoms/field-select/field-select.tsx
index ebdb672..4483040 100644
--- a/ui/src/components/atoms/field-select/field-select.tsx
+++ b/ui/src/components/atoms/field-select/field-select.tsx
@@ -10,8 +10,8 @@ import { Image } from 'expo-image';
 import { useState } from 'react';
 import { Platform, Text, View } from 'react-native';
 import { Dropdown } from 'react-native-element-dropdown';
-import { OtherOption } from '../../molecules/select/select';
-import { FieldOption, FieldSize, FieldState } from '../types/field-types';
+import { OtherOption } from '../../molecules';
+import { FieldOption, FieldSize, FieldState } from '../';
 
 export interface FieldSelectProps<Option> {
   data: Option[];
diff --git a/ui/src/components/index.ts b/ui/src/components/index.ts
index 6c51b7e..477b2da 100644
--- a/ui/src/components/index.ts
+++ b/ui/src/components/index.ts
@@ -2,7 +2,7 @@
 export * from './atoms';
 
 // Molecules are the building blocks that start to define functionality
-// export * from './molecules';
+export * from './molecules';
 
 // Organisms define the structure and layout of a page
 export * from './organisms';
diff --git a/ui/src/components/molecules/index.ts b/ui/src/components/molecules/index.ts
index 61d66e5..b709190 100644
--- a/ui/src/components/molecules/index.ts
+++ b/ui/src/components/molecules/index.ts
@@ -10,8 +10,10 @@
  *
  */
 
-export { Input } from './input/input';
+export type { OtherOption } from './select/select';
+
 export { InputArea } from './input-area/input-area';
+export { Input } from './input/input';
 export { Photo } from './photo/photo';
 export { RadioGroup } from './radio-group/radio-group';
 export { Select } from './select/select';
diff --git a/ui/src/components/pages/pets/create/cats/cat-personality/cat-personality.tsx b/ui/src/components/pages/pets/create/cats/cat-personality/cat-personality.tsx
index 1863c4e..dd816c6 100644
--- a/ui/src/components/pages/pets/create/cats/cat-personality/cat-personality.tsx
+++ b/ui/src/components/pages/pets/create/cats/cat-personality/cat-personality.tsx
@@ -17,7 +17,7 @@ import {
   Tag,
   Toggle,
 } from '../../../../../atoms';
-import { ScrollFeatureTemplate } from '../../../../../templates/scroll-feature-template/scroll-feature-template';
+import { ScrollFeatureTemplate } from '../../../../../templates';
 
 /* eslint-disable-next-line */
 export interface CatPersonalityProps extends PageNavigationProps {}
diff --git a/ui/src/components/pages/pets/create/dogs/dog-personality/dog-personality.tsx b/ui/src/components/pages/pets/create/dogs/dog-personality/dog-personality.tsx
index 7423e6d..d95f605 100644
--- a/ui/src/components/pages/pets/create/dogs/dog-personality/dog-personality.tsx
+++ b/ui/src/components/pages/pets/create/dogs/dog-personality/dog-personality.tsx
@@ -17,7 +17,7 @@ import {
   Tag,
   Toggle,
 } from '../../../../../atoms';
-import { ScrollFeatureTemplate } from '../../../../../templates/scroll-feature-template/scroll-feature-template';
+import { ScrollFeatureTemplate } from '../../../../../templates';
 
 /* eslint-disable-next-line */
 export interface DogPersonalityProps extends PageNavigationProps {}
diff --git a/ui/src/components/pages/pets/create/pet-careplan-options.tsx b/ui/src/components/pages/pets/create/pet-careplan-options.tsx
index 2e650d6..fc5de4b 100644
--- a/ui/src/components/pages/pets/create/pet-careplan-options.tsx
+++ b/ui/src/components/pages/pets/create/pet-careplan-options.tsx
@@ -1,6 +1,6 @@
 import { ruffwind } from '@rufferal/tailwind';
 import { Text } from 'react-native';
-import { OtherOption } from '../../../molecules/select/select';
+import { OtherOption } from '../../../molecules';
 
 /****************** SHARED ******************/
 export const OTHER_OPTION: OtherOption = {
diff --git a/ui/src/components/pages/pets/manage-pets/manage-pets.tsx b/ui/src/components/pages/pets/manage-pets/manage-pets.tsx
index fc0bd67..fd5fb1d 100644
--- a/ui/src/components/pages/pets/manage-pets/manage-pets.tsx
+++ b/ui/src/components/pages/pets/manage-pets/manage-pets.tsx
@@ -17,7 +17,7 @@ import {
   VerticalDivider,
 } from '../../../atoms';
 import { FeatureTemplate } from '../../../templates';
-import { PageNavigationProps } from '../../types/page-props';
+import { PageNavigationProps } from '../..';
 
 // interface ManagePetsProps extends PageNavigationProps {}
 
diff --git a/ui/src/components/pages/profiles/create/pet-splash/pet-splash.tsx b/ui/src/components/pages/profiles/create/pet-splash/pet-splash.tsx
index d9bf4ec..81c115c 100644
--- a/ui/src/components/pages/profiles/create/pet-splash/pet-splash.tsx
+++ b/ui/src/components/pages/profiles/create/pet-splash/pet-splash.tsx
@@ -5,7 +5,7 @@ import { ruffwind } from '@rufferal/tailwind';
 import { verticalScale, verticalScaleTW } from '@rufferal/utils';
 import { Bottomsheet, Button, H2 } from '../../../../atoms';
 import { SplashTemplate } from '../../../../templates';
-import { PageNavigationProps } from '../../../types/page-props';
+import { PageNavigationProps } from '../../..';
 
 // interface PetSplashProps extends PageNavigationProps {}
 

From f4f1723d552b79b6ad7ffad55f1a1c78f9dc3959 Mon Sep 17 00:00:00 2001
From: Priya Power <49959312+priyapower@users.noreply.github.com>
Date: Mon, 23 Sep 2024 13:51:51 -0500
Subject: [PATCH 3/5] Add additional notes on how the app was originally setup

---
 NOTES.md          | 151 ---------------------
 README.md         | 335 ++++++++++++++++++++++++++++++++++++++++++++--
 package-lock.json |  13 ++
 package.json      |   3 +-
 4 files changed, 337 insertions(+), 165 deletions(-)
 delete mode 100644 NOTES.md

diff --git a/NOTES.md b/NOTES.md
deleted file mode 100644
index 71f4d5f..0000000
--- a/NOTES.md
+++ /dev/null
@@ -1,151 +0,0 @@
-```
-origin  git@github.com:Ruffrl/rufferal-frontend.git (fetch)
-origin  git@github.com:Ruffrl/rufferal-frontend.git (push)
-```
-
-// Create a new NX app with expo
-
-```
-npx create-nx-workspace@latest --preset=expo --appName=rufferal
-
-✔ Where would you like to create your workspace? · rufferal-frontend
-✔ Test runner to use for end to end (E2E) tests · cypress
-✔ Which CI provider would you like to use? · github
-```
-
-// Reset git remote
-
-```
-git remote add origin https://github.com/Ruffrl/rufferal-frontend.git
-```
-
-// Create a library for shared components
-
-```
-npx nx generate @nx/expo:lib lib/ui
-<!-- Add your own directory setup here -->
-```
-
-// Add base libraries
-
-```
-react-native-reanimated
-react-native-gesture-handler
-@react-navigation/native
-react-native-safe-area-context
-@react-native-community/masked-view
-react-router-dom@6
-@mui/material
-@emotion/react
-@emotion/styled
-@gorhom/bottom-sheet
-twrnc
-expo-camera
-mobx
-mobx-persist-store
-mobx-react-lite
-@react-native-async-storage/async-storage
-react-hook-form
-yup
-@hookform/resolvers
-@ouroboros/react-native-picker
-@react-native-assets/slider
-react-native-swiper
-```
-
-// Missing from web
-
-```
-"@babel/plugin-proposal-export-namespace-from": "^7.18.9",
-"react-native-web-swiper": "^2.2.4",
-"react-native-web": "~0.19.11",
-"react-webcam": "^7.2.0",
-```
-
-// Test components Test shared library
-
-```
-nx g @nx/expo:component Bottomsheet --directory lib/ui/src/components/atoms/Bottomsheet
-<!-- CONVERT COMPONENT TO ARROW FUNCTION SYNTAX -->
-// import React from 'react';
-import { Text, View } from 'react-native';
-
-/* eslint-disable-next-line */
-export interface BottomsheetProps {}
-
-export const Bottomsheet = (props: BottomsheetProps) => {
-  return (
-    <View>
-      <Text>Welcome to bottomsheet!</Text>
-    </View>
-  );
-};
-
-<!-- lib/ui/src/components/atoms/index.ts -->
-export { Bottomsheet } from './Bottomsheet/bottomsheet';
-
-<!-- lib/ui/src/components/index.ts -->
-export * from './atoms';
-
-<!-- lib/ui/src/index.ts -->
-export * from './components';
-```
-
-// Add a "store" library
-
-```
-npx nx generate @nx/expo:lib lib/store
-<!-- Add your own directory setup here -->
-```
-
-// Add store component
-
-```
-nx g @nx/expo:component account-store --directory lib/store/src/account-store --export
-```
-
-// Add pet profile UI components
-
-```
-nx g @nx/expo:component create-pet-onboarding --directory lib/ui/src/components/pages/pets/create-pet-onboarding  --nameAndDirectoryFormat=as-provided --export=false
-
-nx g @nx/expo:component create-pet-details --directory lib/ui/src/components/pages/pets/create-pet-details --nameAndDirectoryFormat=as-provided --export=false
-
-nx g @nx/expo:component create-pet-photo --directory lib/ui/src/components/pages/pets/create-pet-photo --nameAndDirectoryFormat=as-provided --export=false
-
-nx g @nx/expo:component create-pet-personality --directory lib/ui/src/components/pages/pets/create-pet-personality --nameAndDirectoryFormat=as-provided --export=false
-
-nx g @nx/expo:component create-pet-careplan --directory lib/ui/src/components/pages/pets/create-pet-careplan --nameAndDirectoryFormat=as-provided --export=false
-
- nx g @nx/expo:component manage-pets --directory lib/ui/src/components/pages/pets/manage-pets --nameAndDirectoryFormat=as-provided --export=false
-```
-
-// Add an "assets" library
-
-```
-npx nx generate @nx/expo:lib lib/assets
-<!-- Add your own directory setup here -->
-```
-
-// Install assets
-
-```
-npx expo install expo-asset
-
-<!-- Update app.json plugin -->
-[
-    "expo-asset",
-    {
-        "assets": ["../../lib/assets"]
-    }
-]
-```
-
-// Install fonts
-
-// Components
-```
-nx g @nx/expo:component h2 --directory lib/ui/src/components/atoms/h2 --nameAndDirectoryFormat=as-provided --export=false
-
-nx g @nx/expo:component button --directory lib/ui/src/components/atoms/button --nameAndDirectoryFormat=as-provided --export=false
-```
diff --git a/README.md b/README.md
index 82ad6dc..3fd69e3 100644
--- a/README.md
+++ b/README.md
@@ -113,21 +113,330 @@ _coming soon_
 
 4. Generate components
 
-```bash
-nx g @nx/expo:component bottomsheet --directory ui/src/components/atoms/bottomsheet --nameAndDirectoryFormat=as-provided --export=false
-
-# Updates
-#   - Convert component to arrow component without a default export
-#   - Export component from directory
-#   - 
-#   - 
-```
+   ```bash
+   nx g @nx/expo:component bottomsheet --directory ui/src/components/atoms/bottomsheet --nameAndDirectoryFormat=as-provided --export=false
+
+   # Updates
+   #   - Convert component to arrow component without a default export
+   #   - Export component from directory
+   #      - `ui/src/components/atoms/index.ts`
+   #        - `export { Bottomsheet } from './bottomsheet/bottomsheet';`
+   #      - `ui/src/components/index.ts`
+   #        - `export * from './atoms';`
+   #      - `ui/src/index.ts`
+   #        - `export * from './components';`
+   ```
+
+   Personally, I ended up not using the component generator as it currently is
 
-Personally, I ended up not using the component generator as it currently is
+   - I would like to setup a component generator that applies my system/library expectations
+     - Creates functional (arrow) components instead of default exported normal function componets
+     - exports to local component folder (if in atoms, export is in ./atoms/index.ts, etc)
 
-- I would like to setup a component generator that applies my system/library expectations
-  - Creates functional (arrow) components instead of default exported normal function componets
-  - exports to local component folder (if in atoms, export is in ./atoms/index.ts, etc)
+5. Manage expo assets and update config accordingly
+
+   - [expo-asset](https://docs.expo.dev/versions/latest/sdk/asset/)
+   - [expo-font](https://docs.expo.dev/versions/latest/sdk/font/)
+   - [expo-image-picker](https://docs.expo.dev/versions/latest/sdk/imagepicker/)
+   - [expo-image-manipulator](https://docs.expo.dev/versions/latest/sdk/imagemanipulator/)
+   - [expo-camera](https://docs.expo.dev/versions/latest/sdk/camera/)
+
+   - `apps/rufferal/app.json`
+
+   ```json
+   {
+     ...
+
+     "plugins": [
+       [
+         "expo-image-picker",
+         {
+           "photosPermission": "Allow Rufferal to access your photos"
+         }
+       ],
+       [
+         "expo-camera",
+         {
+           "cameraPermission": "Allow Rufferal to access your camera",
+           "microphonePermission": "Allow Rufferal to access your microphone",
+           "recordAudioAndroid": true
+         }
+       ],
+       [
+         "expo-asset",
+         {
+           "assets": ["../../lib/assets/images"]
+         }
+       ],
+       [
+         "expo-font",
+         {
+           "fonts": [
+             "../../assets/src/fonts/proxima-nova/proximanova_bold.otf",
+             "../../assets/src/fonts/proxima-nova/proximanova_extrabold.otf",
+             "../../assets/src/fonts/proxima-nova/proximanova_semibold.otf",
+             "../../assets/src/fonts/inter/inter_bold.otf",
+             "../../assets/src/fonts/inter/inter_regular_italic.otf",
+             "../../assets/src/fonts/inter/inter_regular.otf",
+             "../../assets/src/fonts/inter/inter_semibold.otf",
+             "../../assets/src/fonts/inter/inter_medium.otf"
+           ]
+         }
+       ]
+     ]
+   }
+   ```
+
+6. Manage custom styles
+
+   - Using [Tailwind](https://tailwindcss.com/docs/adding-custom-styles) and [package](https://www.npmjs.com/package/twrnc) docs
+   - Add custom fonts
+   - Add style/theme overrides
+   - Currently in a single config file
+     - `tailwind/src/tailwind.config.js`
+
+   ```javascript
+   import { moderateScale } from '@rufferal/utils';
+
+   /** @type {import('tailwindcss').Config} */
+   module.exports = {
+     content: [],
+     theme: {
+       extend: {
+         colors: {
+           blizzardBlue: {
+             50: '#ECFDFF',
+             100: '#CEF8FF',
+             200: '#A0EFFE', // PRIMARY
+             300: '#64E2FC',
+             400: '#1DCBF3',
+             500: '#01ADD9',
+             600: '#0489B6',
+             700: '#0B6E93',
+             800: '#135977',
+             900: '#144A65',
+             950: '#073145',
+           },
+           whitePointer: {
+             50: '#FDF9FF', // PRIMARY
+             100: '#F7E8FF',
+             200: '#F0D5FF',
+             300: '#E4B4FE',
+             400: '#D484FC',
+             500: '#C355F7',
+             600: '#B233EA',
+             700: '#9B22CE',
+             800: '#8221A8',
+             900: '#6A1C87',
+             950: '#4B0764',
+           },
+           balticSea: {
+             50: '#F6F4F9',
+             100: '#EFEBF4',
+             200: '#E2DBEA',
+             300: '#D0C5DC',
+             400: '#BEADCC',
+             500: '#AF98BC',
+             600: '#9D81AA',
+             700: '#896E94',
+             800: '#6E5B78',
+             900: '#5B4D62',
+             950: '#2B242E', // PRIMARY
+           },
+           electricViolet: {
+             50: '#FBF5FF',
+             100: '#F6E8FF',
+             200: '#EFD6FE',
+             300: '#E2B5FD',
+             400: '#D086FA',
+             500: '#BE58F4',
+             600: '#AC36E7',
+             700: '#9525CB', // PRIMARY
+             800: '#7D23A6',
+             900: '#661E85',
+             950: '#470962',
+           },
+           seance: {
+             50: '#FBF5FF',
+             100: '#F6E9FE',
+             200: '#EFD6FE',
+             300: '#E2B6FC',
+             400: '#D087F9',
+             500: '#BE59F3',
+             600: '#AC37E6',
+             700: '#9526CA',
+             800: '#7D24A5', // PRIMARY
+             900: '#671E85',
+             950: '#480962',
+           },
+           wildSand: {
+             50: '#F6F6F6', // PRIMARY
+             100: '#EFEFEF',
+             200: '#DCDCDC',
+             300: '#BDBDBD',
+             400: '#989898',
+             500: '#7C7C7C',
+             600: '#656565',
+             700: '#525252',
+             800: '#464646',
+             900: '#3D3D3D',
+             950: '#292929',
+           },
+           iron: {
+             50: '#F7F7F7',
+             100: '#EDEDED',
+             200: '#D8D8D8', // DISABLED
+             300: '#D1D1D1', // PRIMARY
+             400: '#ADADAD',
+             500: '#999999', // DISABLED
+             600: '#888888',
+             700: '#7B7B7B',
+             800: '#676767',
+             900: '#545454',
+             950: '#363636',
+           },
+           graySuit: {
+             50: '#F9F8FA',
+             100: '#F4F2F5',
+             200: '#E9E8EC',
+             300: '#D8D5DD',
+             400: '#CAC4D0', // PRIMARY
+             500: '#AA9FB3',
+             600: '#97889F',
+             700: '#83768B',
+             800: '#6E6275',
+             900: '#5A5260',
+             950: '#3C3540',
+           },
+           saltBox: {
+             50: '#FAF9FA',
+             100: '#F3F2F5',
+             200: '#E8E4EA',
+             300: '#D4CED9',
+             400: '#BBB1C1',
+             500: '#9E90A5',
+             600: '#807188',
+             700: '#695C6F', // PRIMARY
+             800: '#564C5C',
+             900: '#4A424D',
+             950: '#2B242E',
+           },
+           lola: {
+             50: '#F9F8FA',
+             100: '#F4F2F5',
+             200: '#EBE7ED',
+             300: '#D5CED9', // PRIMARY
+             400: '#C5BBCA',
+             500: '#AE9FB3',
+             600: '#9A889F',
+             700: '#88758C',
+             800: '#716275',
+             900: '#5E5161',
+             950: '#3E3540',
+           },
+           red: {
+             50: '#fff3f1',
+             100: '#ffe3df',
+             200: '#ffcbc4',
+             300: '#ffa69b',
+             400: '#ff7462',
+             500: '#ff4931',
+             600: '#e8270e', // PRIMARY
+             700: '#cb200a',
+             800: '#a71f0d',
+             900: '#8a2012',
+             950: '#4c0b03',
+           },
+           silver: {
+             50: '#F7F7F7',
+             100: '#EDEDED',
+             200: '#DFDFDF',
+             300: '#C9C9C9', // PRIMARY
+             400: '#ADADAD',
+             500: '#999999',
+             600: '#888888',
+             700: '#7B7B7B',
+             800: '#676767',
+             900: '#545454',
+             950: '#363636',
+           },
+           codGray: {
+             50: '#F6F6F6',
+             100: '#E7E7E7',
+             200: '#D1D1D1',
+             300: '#B0B0B0',
+             400: '#888888',
+             500: '#6D6D6D',
+             600: '#5D5D5D',
+             700: '#4F4F4F',
+             800: '#454545',
+             900: '#3D3D3D',
+             950: '#080808', // PRIMARY
+           },
+           amethystSmoke: {
+             50: '#F9F8FA',
+             100: '#F4F2F5',
+             200: '#EAE7ED',
+             300: '#D9D4DE',
+             400: '#C3BCC9',
+             500: '#AC9FB3',
+             600: '#9F90A5', // PRIMARY
+             700: '#86758C',
+             800: '#706275',
+             900: '#5D5161',
+             950: '#3D3540',
+           },
+           azureRadiance: {
+             100: '#D6F2FF',
+             200: '#B5EAFF',
+             300: '#83DFFF',
+             400: '#48CBFF',
+             50: '#EDFAFF',
+             500: '#1EACFF',
+             600: '#068EFF',
+             700: '#007AFF', // PRIMARY
+             800: '#085DC5',
+             900: '#0D519B',
+             950: '#0E315D',
+           },
+           chatelle: {
+             50: '#FAF8FA',
+             100: '#F4F2F5',
+             200: '#EAE8EC',
+             300: '#D9D5DD',
+             400: '#BCB1C1', // PRIMARY
+             500: '#AE9FB3',
+             600: '#9B889F',
+             700: '#88758C',
+             800: '#716275',
+             900: '#5D5260',
+             950: '#3E3540',
+           },
+         },
+         fontFamily: {
+           body: ['Inter Regular'], // 400
+           bodyItalic: ['Inter Regular Italic'],
+           bodyMedium: ['Inter Medium'], // 500
+           bodySemibold: ['Inter Semibold'], // 600
+           bodyBold: ['Inter Bold'], // 700
+           headerSemibold: ['Proxima Nova Semibold'], // 600
+           headerBold: ['Proxima Nova Bold'], // 700
+           headerExtrabold: ['Proxima Nova Extrabold'], // 800
+         },
+         fontSize: {
+           b1: [`${moderateScale(10)}px`, `${moderateScale(14)}px`],
+           b2: [`${moderateScale(12)}px`, `${moderateScale(16)}px`],
+           b3: [`${moderateScale(14)}px`, `${moderateScale(20)}px`],
+           b4: [`${moderateScale(16)}px`, `${moderateScale(24)}px`],
+           h3: [`${moderateScale(22)}px`, `${moderateScale(26)}px`],
+           h2: [`${moderateScale(28)}px`, `${moderateScale(30)}px`],
+           h1: [`${moderateScale(32)}px`, `${moderateScale(36)}px`],
+         },
+       },
+     },
+     plugins: [],
+   };
+   ```
 
 ## (PROTOTYPE) Themes
 
diff --git a/package-lock.json b/package-lock.json
index c81996e..e5793dc 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -27,6 +27,7 @@
         "expo-camera": "~15.0.16",
         "expo-font": "~12.0.10",
         "expo-image": "~1.12.15",
+        "expo-image-manipulator": "~12.0.5",
         "expo-image-picker": "~15.0.7",
         "expo-splash-screen": "~0.27.4",
         "expo-status-bar": "~1.12.1",
@@ -16548,6 +16549,18 @@
         "expo": "*"
       }
     },
+    "node_modules/expo-image-manipulator": {
+      "version": "12.0.5",
+      "resolved": "https://registry.npmjs.org/expo-image-manipulator/-/expo-image-manipulator-12.0.5.tgz",
+      "integrity": "sha512-zJ8yINjckYw/yfoSuICt4yJ9xr112+W9e5QVXwK3nCAHr7sv45RQ5sxte0qppf594TPl+UoV6Tjim7WpoKipRQ==",
+      "license": "MIT",
+      "dependencies": {
+        "expo-image-loader": "~4.7.0"
+      },
+      "peerDependencies": {
+        "expo": "*"
+      }
+    },
     "node_modules/expo-image-picker": {
       "version": "15.0.7",
       "resolved": "https://registry.npmjs.org/expo-image-picker/-/expo-image-picker-15.0.7.tgz",
diff --git a/package.json b/package.json
index a63e699..0890b70 100644
--- a/package.json
+++ b/package.json
@@ -47,7 +47,8 @@
     "react-router-dom": "^6.26.2",
     "tslib": "^2.3.0",
     "twrnc": "^4.5.1",
-    "yup": "^1.4.0"
+    "yup": "^1.4.0",
+    "expo-image-manipulator": "~12.0.5"
   },
   "devDependencies": {
     "@expo/cli": "~0.18.13",

From 66816a26e90aa4c7934a44f6938e1cabb88214d7 Mon Sep 17 00:00:00 2001
From: Priya Power <49959312+priyapower@users.noreply.github.com>
Date: Mon, 23 Sep 2024 13:53:48 -0500
Subject: [PATCH 4/5] Remove e2e for now

---
 .github/workflows/ci.yml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 428f2b2..e4b2c69 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -34,5 +34,6 @@ jobs:
 
       # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
       # - run: npx nx-cloud record -- echo Hello World
+      
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
-      - run: npx nx affected -t lint test build e2e-ci
+      # - run: npx nx affected -t lint test build e2e-ci

From d5069dd2907e1cd1bb45436db0f7f654aaaf728d Mon Sep 17 00:00:00 2001
From: Priya Power <49959312+priyapower@users.noreply.github.com>
Date: Mon, 23 Sep 2024 14:28:40 -0500
Subject: [PATCH 5/5] Add LICENSE and final draft installation updates to
 README

---
 LICENSE.md | 661 ++++++++++++++++++++++++++++++++++++++++
 README.md  | 867 ++++++++++++++++++++++++++++++++---------------------
 2 files changed, 1193 insertions(+), 335 deletions(-)
 create mode 100644 LICENSE.md

diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..162676c
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+                            Preamble
+
+The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+0. Definitions.
+
+"This License" refers to version 3 of the GNU Affero General Public License.
+
+"Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+1. Source Code.
+
+The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+The Corresponding Source for a work in source code form is that
+same work.
+
+2. Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+8. Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+13. Remote Network Interaction; Use with the GNU General Public License.
+
+Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.
diff --git a/README.md b/README.md
index 3fd69e3..e4c37d7 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,80 @@
 # Rufferal Frontend
 
-blarg
+This repository contains the frontend codebase for an easy to use, pet friendly, care services application called Rufferal. The application is built using React Native and is designed to be responsive across multiple platforms including Android and iOS (_coming soon: desktop & mobile-web_).
 
-Things to think about
+## Table of contents
 
+- [Demo](#demo)
+- [Features](#features)
+- [Accessibility considerations](#accessibility-considerations)
+- [Extensions](#extensions)
+- [Design](#design)
+- [Software architecture](#software-architecture)
+- [Installation](#installation)
+- [About the creators](#about-the-creators)
+<!-- - [Contributing](#contributing) -->
+- [License](#license)
+- [Acknowledgments](#acknowledgments)
+
+## Demo
+
+[ video ]
+
+[ desktop screengrab ]
+
+[ mobile web screengrab ]
+
+[ android screengrab ]
+
+[ ios screengrab ]
+
+## Features
+
+- **Cross-platform Compatibility**: Supports desktop browsers, mobile web browsers, Android devices, and iOS devices.
+- **Easy Onboarding and Research Caretakers**: Pet owners can skip sign in and directly browse services before signing up.
+- **User Authentication**: Secure user authentication and authorization flows with phone number, email, and social sign on.
+- **Community Referrals**: Pet owners can provide referrals (Ruffrls) to give insight into their experience with Caretakers and pet owners can see referral details while searching.
+- **Build or View Pet Profiles**: Fill out pet profiles to provide details about pet care as well as
+- **Gain Trust**: Caretakers can show off their qualifications via friendly and fun icons as well as set transparent prices.
+- **Book Care for Your Pet**: Pet owners can book various pet care services.
+- **Book Gigs**: Caretakers can browse available services by Pet and see
+- **Switch Modes**: Easily switch between Pet owner or Caretaker to book gigs or book services.
+- **Payment Integration**: Integration with a secure payment gateway for handling transactions.
+- **Profile Management**: Users can manage their profiles and pet information.
+
+## Accessibility Considerations
+
+[ axe and other services screenshots, or walkthrough, or whatever evidence we can produce here]
+
+[ details/list ]
+
+### Device support
+
+- IOS (versions _coming soon_ and above)
+- Android (versions _coming soon_ and above)
+- mobile-web and desktop _coming soon_
+
+## Extensions
+
+- **Notifications**: Push notifications for appointment and payment reminders, messaging notifications, and updates.
+- **Internal Messaging**: 1:1 messaging between Pet owners and caretakers to communicate details, discuss payment, receive updates about their pets, and so much more.
+- **AI Powered Care Plans**: Pet Owners can use our AI powered assistant, Ruffles, to create caretaker friendly care plan to attach to their pet's profile that can include walking details, overnight details, elderly pet details, pet medical details, and more
+- Details about Ruffles
+  - Ruffles would be a charming and distinctive companion, known for their unique fluffy coat and friendly demeanor. They would capture hearts with their adorable appearance and playful personality, making them a cherished member of any household.
+  - Physical Characteristics:
+    - Breed: A mixed breed with a uniquely fluffy and slightly unkempt appearance, possibly a combination of breeds like a Shih Tzu and Pomeranian mix.
+    - Size: Small to medium-sized, compact but with a fluffy and slightly tousled coat.
+    - Coat: Soft and voluminous, resembling the texture of wind-blown fur, with slight waves or curls.
+    - Color: Varied shades of cream and light brown, with patches or streaks of darker colors adding to their distinctive look.
+  - Facial Features:
+    - Eyes: Round and expressive, often dark brown or amber in color, conveying curiosity and intelligence.
+    - Ears: Medium-sized and covered with tufts of fur, often perking up at the slightest sound or movement.
+    - Expression: Sweet and endearing, with a hint of mischievousness in their gaze.
+  - Personality Traits:
+    - Cheerful: Always wearing a bright, happy expression, eager to explore and engage in playful activities.
+    - Affectionate: Loves cuddling and being close to their human family members, seeking attention and affection.
+    - Energetic: Despite their fluffy appearance, Ruffles is surprisingly agile and enjoys running around and playing fetch.
+    - Intelligent: Quick to learn new tricks and commands, showing off their cleverness and eagerness to please.
 - graphql
 - error handling
 - security handling
@@ -15,11 +86,256 @@ Things to think about
 - deployment
 - other developer nice to haves
 
-## Device support
-
-- IOS (versions _coming soon_ and above)
-- Android (versions _coming soon_ and above)
-- mobile-web and desktop _coming soon_
+## Design
+
+### Themes
+
+_more coming soon_
+
+_CURRENT SETUP tailwind/src/tailwind.config.js_
+
+```javascript
+import { moderateScale } from '@rufferal/utils';
+
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  content: [],
+  theme: {
+    extend: {
+      colors: {
+        blizzardBlue: {
+          50: '#ECFDFF',
+          100: '#CEF8FF',
+          200: '#A0EFFE', // PRIMARY
+          300: '#64E2FC',
+          400: '#1DCBF3',
+          500: '#01ADD9',
+          600: '#0489B6',
+          700: '#0B6E93',
+          800: '#135977',
+          900: '#144A65',
+          950: '#073145',
+        },
+        whitePointer: {
+          50: '#FDF9FF', // PRIMARY
+          100: '#F7E8FF',
+          200: '#F0D5FF',
+          300: '#E4B4FE',
+          400: '#D484FC',
+          500: '#C355F7',
+          600: '#B233EA',
+          700: '#9B22CE',
+          800: '#8221A8',
+          900: '#6A1C87',
+          950: '#4B0764',
+        },
+        balticSea: {
+          50: '#F6F4F9',
+          100: '#EFEBF4',
+          200: '#E2DBEA',
+          300: '#D0C5DC',
+          400: '#BEADCC',
+          500: '#AF98BC',
+          600: '#9D81AA',
+          700: '#896E94',
+          800: '#6E5B78',
+          900: '#5B4D62',
+          950: '#2B242E', // PRIMARY
+        },
+        electricViolet: {
+          50: '#FBF5FF',
+          100: '#F6E8FF',
+          200: '#EFD6FE',
+          300: '#E2B5FD',
+          400: '#D086FA',
+          500: '#BE58F4',
+          600: '#AC36E7',
+          700: '#9525CB', // PRIMARY
+          800: '#7D23A6',
+          900: '#661E85',
+          950: '#470962',
+        },
+        seance: {
+          50: '#FBF5FF',
+          100: '#F6E9FE',
+          200: '#EFD6FE',
+          300: '#E2B6FC',
+          400: '#D087F9',
+          500: '#BE59F3',
+          600: '#AC37E6',
+          700: '#9526CA',
+          800: '#7D24A5', // PRIMARY
+          900: '#671E85',
+          950: '#480962',
+        },
+        wildSand: {
+          50: '#F6F6F6', // PRIMARY
+          100: '#EFEFEF',
+          200: '#DCDCDC',
+          300: '#BDBDBD',
+          400: '#989898',
+          500: '#7C7C7C',
+          600: '#656565',
+          700: '#525252',
+          800: '#464646',
+          900: '#3D3D3D',
+          950: '#292929',
+        },
+        iron: {
+          50: '#F7F7F7',
+          100: '#EDEDED',
+          200: '#D8D8D8', // DISABLED
+          300: '#D1D1D1', // PRIMARY
+          400: '#ADADAD',
+          500: '#999999', // DISABLED
+          600: '#888888',
+          700: '#7B7B7B',
+          800: '#676767',
+          900: '#545454',
+          950: '#363636',
+        },
+        graySuit: {
+          50: '#F9F8FA',
+          100: '#F4F2F5',
+          200: '#E9E8EC',
+          300: '#D8D5DD',
+          400: '#CAC4D0', // PRIMARY
+          500: '#AA9FB3',
+          600: '#97889F',
+          700: '#83768B',
+          800: '#6E6275',
+          900: '#5A5260',
+          950: '#3C3540',
+        },
+        saltBox: {
+          50: '#FAF9FA',
+          100: '#F3F2F5',
+          200: '#E8E4EA',
+          300: '#D4CED9',
+          400: '#BBB1C1',
+          500: '#9E90A5',
+          600: '#807188',
+          700: '#695C6F', // PRIMARY
+          800: '#564C5C',
+          900: '#4A424D',
+          950: '#2B242E',
+        },
+        lola: {
+          50: '#F9F8FA',
+          100: '#F4F2F5',
+          200: '#EBE7ED',
+          300: '#D5CED9', // PRIMARY
+          400: '#C5BBCA',
+          500: '#AE9FB3',
+          600: '#9A889F',
+          700: '#88758C',
+          800: '#716275',
+          900: '#5E5161',
+          950: '#3E3540',
+        },
+        red: {
+          50: '#fff3f1',
+          100: '#ffe3df',
+          200: '#ffcbc4',
+          300: '#ffa69b',
+          400: '#ff7462',
+          500: '#ff4931',
+          600: '#e8270e', // PRIMARY
+          700: '#cb200a',
+          800: '#a71f0d',
+          900: '#8a2012',
+          950: '#4c0b03',
+        },
+        silver: {
+          50: '#F7F7F7',
+          100: '#EDEDED',
+          200: '#DFDFDF',
+          300: '#C9C9C9', // PRIMARY
+          400: '#ADADAD',
+          500: '#999999',
+          600: '#888888',
+          700: '#7B7B7B',
+          800: '#676767',
+          900: '#545454',
+          950: '#363636',
+        },
+        codGray: {
+          50: '#F6F6F6',
+          100: '#E7E7E7',
+          200: '#D1D1D1',
+          300: '#B0B0B0',
+          400: '#888888',
+          500: '#6D6D6D',
+          600: '#5D5D5D',
+          700: '#4F4F4F',
+          800: '#454545',
+          900: '#3D3D3D',
+          950: '#080808', // PRIMARY
+        },
+        amethystSmoke: {
+          50: '#F9F8FA',
+          100: '#F4F2F5',
+          200: '#EAE7ED',
+          300: '#D9D4DE',
+          400: '#C3BCC9',
+          500: '#AC9FB3',
+          600: '#9F90A5', // PRIMARY
+          700: '#86758C',
+          800: '#706275',
+          900: '#5D5161',
+          950: '#3D3540',
+        },
+        azureRadiance: {
+          100: '#D6F2FF',
+          200: '#B5EAFF',
+          300: '#83DFFF',
+          400: '#48CBFF',
+          50: '#EDFAFF',
+          500: '#1EACFF',
+          600: '#068EFF',
+          700: '#007AFF', // PRIMARY
+          800: '#085DC5',
+          900: '#0D519B',
+          950: '#0E315D',
+        },
+        chatelle: {
+          50: '#FAF8FA',
+          100: '#F4F2F5',
+          200: '#EAE8EC',
+          300: '#D9D5DD',
+          400: '#BCB1C1', // PRIMARY
+          500: '#AE9FB3',
+          600: '#9B889F',
+          700: '#88758C',
+          800: '#716275',
+          900: '#5D5260',
+          950: '#3E3540',
+        },
+      },
+      fontFamily: {
+        body: ['Inter Regular'], // 400
+        bodyItalic: ['Inter Regular Italic'],
+        bodyMedium: ['Inter Medium'], // 500
+        bodySemibold: ['Inter Semibold'], // 600
+        bodyBold: ['Inter Bold'], // 700
+        headerSemibold: ['Proxima Nova Semibold'], // 600
+        headerBold: ['Proxima Nova Bold'], // 700
+        headerExtrabold: ['Proxima Nova Extrabold'], // 800
+      },
+      fontSize: {
+        b1: [`${moderateScale(10)}px`, `${moderateScale(14)}px`],
+        b2: [`${moderateScale(12)}px`, `${moderateScale(16)}px`],
+        b3: [`${moderateScale(14)}px`, `${moderateScale(20)}px`],
+        b4: [`${moderateScale(16)}px`, `${moderateScale(24)}px`],
+        h3: [`${moderateScale(22)}px`, `${moderateScale(26)}px`],
+        h2: [`${moderateScale(28)}px`, `${moderateScale(30)}px`],
+        h1: [`${moderateScale(32)}px`, `${moderateScale(36)}px`],
+      },
+    },
+  },
+  plugins: [],
+};
+```
 
 ### Mobile/web mobile viewport sizes
 
@@ -54,12 +370,116 @@ _coming soon_
 
 _coming soon_
 
-## Themes
+## Software architecture
 
-_coming soon_
+[ diagram goes here ]
+
+See [backend](https://github.com/Ruffrl/rufferal-backend)
+
+### Tech stack
+
+- **React**: JavaScript library for building user interfaces.
+- **React Native**: Framework for building native applications using React.
+- **TypeScript**: Strict syntactical superset of JavaScript.
+- **MobX**: State management library for React applications.
+- **Styled Components**: CSS-in-JS styling solution.
+  - **EXTENSION**: Tailwind refactor
+- **React Navigation**: Routing and navigation for React Native applications.
+- **Axios**: Promise-based HTTP client for making API requests.
+- **EXTENSION Apollo Client**: A JavaScript library that helps manage data with GraphQL, both locally and remotely.
 
 ## Installation
 
+To get a local copy of the project up and running follow these steps:
+
+### Prerequisites
+
+- Repo/organization permissions
+- Node
+- npm
+- Android Studio
+  - virtual device setup
+- XCode
+  - simulator setup
+
+### Repository
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/Ruffrl/rufferal-frontend.git
+   cd rufferal-frontend
+   ```
+
+- https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
+
+2. Install dependencies:
+
+   ```bash
+   npm install
+   ```
+
+### Running the Application
+
+- **Mobile** (React Native on Expo):
+
+  Ensure you have set up the development environment based on your target platform (iOS or Android).
+
+  - https://reactnative.dev/docs/environment-setup
+  - https://docs.expo.dev/get-started/set-up-your-environment/?mode=development-build
+
+  ```bash
+  npx nx run rufferal:start
+  ```
+
+  Follow in-server instructions to open android `a` or ios `i`
+  Simulators should open automatically, they may take a minute to load and bundle
+
+  OPTIONALLY
+
+  ```bash
+  npx nx run rufferal:run-android  # For Android
+  npx nx run rufferal:run-ios  # For iOS
+  ```
+
+      - Troubleshooting?
+        - Sometimes you need to open Android Studio -> Virtual Devices -> Select and run a device
+
+  Future
+
+      - Fullstack server?
+      - Debugging servers?
+
+- **Web** (Expo web):
+
+  ```bash
+  npx nx run rufferal:start
+  ```
+
+  Follow in-server instructions to open on web (w)
+  OR
+  Open [http://localhost:3000](http://localhost:3000) in your browser.
+
+<!-- - **Web** (React):
+
+  ```bash
+  npx nx run rufferal-web:start
+  ```
+
+  Open [http://localhost:3000](http://localhost:3000) in your browser. -->
+
+### Building for production
+
+- **Mobile** (React Native):
+  _coming soon_
+  - https://nx.dev/nx-api/expo/executors/build
+  - https://nx.dev/reference/project-configuration#targets
+  - https://blog.nrwl.io/step-by-step-guide-to-creating-an-expo-monorepo-with-nx-30c976fdc2c1
+  - https://medium.com/@arkadi.berikashvili/react-native-eas-builds-on-nx-nrwl-expo-using-github-workflows-80f420f52563
+
+- **Web**:
+  _coming soon_
+
 ### How this app was setup
 
 1. Create a new NX app with expo
@@ -194,251 +614,110 @@ _coming soon_
    - Add style/theme overrides
    - Currently in a single config file
      - `tailwind/src/tailwind.config.js`
+     - See [themes](#themes)
 
-   ```javascript
-   import { moderateScale } from '@rufferal/utils';
-
-   /** @type {import('tailwindcss').Config} */
-   module.exports = {
-     content: [],
-     theme: {
-       extend: {
-         colors: {
-           blizzardBlue: {
-             50: '#ECFDFF',
-             100: '#CEF8FF',
-             200: '#A0EFFE', // PRIMARY
-             300: '#64E2FC',
-             400: '#1DCBF3',
-             500: '#01ADD9',
-             600: '#0489B6',
-             700: '#0B6E93',
-             800: '#135977',
-             900: '#144A65',
-             950: '#073145',
-           },
-           whitePointer: {
-             50: '#FDF9FF', // PRIMARY
-             100: '#F7E8FF',
-             200: '#F0D5FF',
-             300: '#E4B4FE',
-             400: '#D484FC',
-             500: '#C355F7',
-             600: '#B233EA',
-             700: '#9B22CE',
-             800: '#8221A8',
-             900: '#6A1C87',
-             950: '#4B0764',
-           },
-           balticSea: {
-             50: '#F6F4F9',
-             100: '#EFEBF4',
-             200: '#E2DBEA',
-             300: '#D0C5DC',
-             400: '#BEADCC',
-             500: '#AF98BC',
-             600: '#9D81AA',
-             700: '#896E94',
-             800: '#6E5B78',
-             900: '#5B4D62',
-             950: '#2B242E', // PRIMARY
-           },
-           electricViolet: {
-             50: '#FBF5FF',
-             100: '#F6E8FF',
-             200: '#EFD6FE',
-             300: '#E2B5FD',
-             400: '#D086FA',
-             500: '#BE58F4',
-             600: '#AC36E7',
-             700: '#9525CB', // PRIMARY
-             800: '#7D23A6',
-             900: '#661E85',
-             950: '#470962',
-           },
-           seance: {
-             50: '#FBF5FF',
-             100: '#F6E9FE',
-             200: '#EFD6FE',
-             300: '#E2B6FC',
-             400: '#D087F9',
-             500: '#BE59F3',
-             600: '#AC37E6',
-             700: '#9526CA',
-             800: '#7D24A5', // PRIMARY
-             900: '#671E85',
-             950: '#480962',
-           },
-           wildSand: {
-             50: '#F6F6F6', // PRIMARY
-             100: '#EFEFEF',
-             200: '#DCDCDC',
-             300: '#BDBDBD',
-             400: '#989898',
-             500: '#7C7C7C',
-             600: '#656565',
-             700: '#525252',
-             800: '#464646',
-             900: '#3D3D3D',
-             950: '#292929',
-           },
-           iron: {
-             50: '#F7F7F7',
-             100: '#EDEDED',
-             200: '#D8D8D8', // DISABLED
-             300: '#D1D1D1', // PRIMARY
-             400: '#ADADAD',
-             500: '#999999', // DISABLED
-             600: '#888888',
-             700: '#7B7B7B',
-             800: '#676767',
-             900: '#545454',
-             950: '#363636',
-           },
-           graySuit: {
-             50: '#F9F8FA',
-             100: '#F4F2F5',
-             200: '#E9E8EC',
-             300: '#D8D5DD',
-             400: '#CAC4D0', // PRIMARY
-             500: '#AA9FB3',
-             600: '#97889F',
-             700: '#83768B',
-             800: '#6E6275',
-             900: '#5A5260',
-             950: '#3C3540',
-           },
-           saltBox: {
-             50: '#FAF9FA',
-             100: '#F3F2F5',
-             200: '#E8E4EA',
-             300: '#D4CED9',
-             400: '#BBB1C1',
-             500: '#9E90A5',
-             600: '#807188',
-             700: '#695C6F', // PRIMARY
-             800: '#564C5C',
-             900: '#4A424D',
-             950: '#2B242E',
-           },
-           lola: {
-             50: '#F9F8FA',
-             100: '#F4F2F5',
-             200: '#EBE7ED',
-             300: '#D5CED9', // PRIMARY
-             400: '#C5BBCA',
-             500: '#AE9FB3',
-             600: '#9A889F',
-             700: '#88758C',
-             800: '#716275',
-             900: '#5E5161',
-             950: '#3E3540',
-           },
-           red: {
-             50: '#fff3f1',
-             100: '#ffe3df',
-             200: '#ffcbc4',
-             300: '#ffa69b',
-             400: '#ff7462',
-             500: '#ff4931',
-             600: '#e8270e', // PRIMARY
-             700: '#cb200a',
-             800: '#a71f0d',
-             900: '#8a2012',
-             950: '#4c0b03',
-           },
-           silver: {
-             50: '#F7F7F7',
-             100: '#EDEDED',
-             200: '#DFDFDF',
-             300: '#C9C9C9', // PRIMARY
-             400: '#ADADAD',
-             500: '#999999',
-             600: '#888888',
-             700: '#7B7B7B',
-             800: '#676767',
-             900: '#545454',
-             950: '#363636',
-           },
-           codGray: {
-             50: '#F6F6F6',
-             100: '#E7E7E7',
-             200: '#D1D1D1',
-             300: '#B0B0B0',
-             400: '#888888',
-             500: '#6D6D6D',
-             600: '#5D5D5D',
-             700: '#4F4F4F',
-             800: '#454545',
-             900: '#3D3D3D',
-             950: '#080808', // PRIMARY
-           },
-           amethystSmoke: {
-             50: '#F9F8FA',
-             100: '#F4F2F5',
-             200: '#EAE7ED',
-             300: '#D9D4DE',
-             400: '#C3BCC9',
-             500: '#AC9FB3',
-             600: '#9F90A5', // PRIMARY
-             700: '#86758C',
-             800: '#706275',
-             900: '#5D5161',
-             950: '#3D3540',
-           },
-           azureRadiance: {
-             100: '#D6F2FF',
-             200: '#B5EAFF',
-             300: '#83DFFF',
-             400: '#48CBFF',
-             50: '#EDFAFF',
-             500: '#1EACFF',
-             600: '#068EFF',
-             700: '#007AFF', // PRIMARY
-             800: '#085DC5',
-             900: '#0D519B',
-             950: '#0E315D',
-           },
-           chatelle: {
-             50: '#FAF8FA',
-             100: '#F4F2F5',
-             200: '#EAE8EC',
-             300: '#D9D5DD',
-             400: '#BCB1C1', // PRIMARY
-             500: '#AE9FB3',
-             600: '#9B889F',
-             700: '#88758C',
-             800: '#716275',
-             900: '#5D5260',
-             950: '#3E3540',
-           },
-         },
-         fontFamily: {
-           body: ['Inter Regular'], // 400
-           bodyItalic: ['Inter Regular Italic'],
-           bodyMedium: ['Inter Medium'], // 500
-           bodySemibold: ['Inter Semibold'], // 600
-           bodyBold: ['Inter Bold'], // 700
-           headerSemibold: ['Proxima Nova Semibold'], // 600
-           headerBold: ['Proxima Nova Bold'], // 700
-           headerExtrabold: ['Proxima Nova Extrabold'], // 800
-         },
-         fontSize: {
-           b1: [`${moderateScale(10)}px`, `${moderateScale(14)}px`],
-           b2: [`${moderateScale(12)}px`, `${moderateScale(16)}px`],
-           b3: [`${moderateScale(14)}px`, `${moderateScale(20)}px`],
-           b4: [`${moderateScale(16)}px`, `${moderateScale(24)}px`],
-           h3: [`${moderateScale(22)}px`, `${moderateScale(26)}px`],
-           h2: [`${moderateScale(28)}px`, `${moderateScale(30)}px`],
-           h1: [`${moderateScale(32)}px`, `${moderateScale(36)}px`],
-         },
-       },
-     },
-     plugins: [],
-   };
-   ```
+## About the creators
+
+- Sara Flores
+- Priya Power
+
+<!-- ## Contributing
 
-## (PROTOTYPE) Themes
+Contributions are welcome! Please follow the guidelines outlined in [CONTRIBUTING.md](CONTRIBUTING.md). -->
+
+## License
+
+This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Hat tip to anyone whose code was used
+- Inspiration
+- etc.
+
+<!-- ### NX Notes
+
+<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
+
+✨ Your new, shiny [Nx workspace](https://nx.dev) is almost ready ✨.
+
+[Learn more about this workspace setup and its capabilities](https://nx.dev/nx-api/expo?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed!
+
+#### Finish your CI setup
+
+[Click here to finish setting up your workspace!](https://cloud.nx.app/connect/FWnkRYuUP7)
+
+#### Run tasks
+
+To run the dev server for your app, use:
+
+```sh
+npx nx serve rufferal
+```
+
+To create a production bundle:
+
+```sh
+npx nx build rufferal
+```
+
+To see all available targets to run for a project, run:
+
+```sh
+npx nx show project rufferal
+```
+
+These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files.
+
+[More about running tasks in the docs &raquo;](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
+
+#### Add new projects
+
+While you could add new projects to your workspace manually, you might want to leverage [Nx plugins](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) and their [code generation](https://nx.dev/features/generate-code?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) feature.
+
+Use the plugin's generator to create new projects.
+
+To generate a new application, use:
+
+```sh
+npx nx g @nx/expo:app demo
+```
+
+To generate a new library, use:
+
+```sh
+npx nx g @nx/react:lib mylib
+```
+
+You can use `npx nx list` to get a list of installed plugins. Then, run `npx nx list <plugin-name>` to learn about more specific capabilities of a particular plugin. Alternatively, [install Nx Console](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) to browse plugins and generators in your IDE.
+
+[Learn more about Nx plugins &raquo;](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | [Browse the plugin registry &raquo;](https://nx.dev/plugin-registry?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
+
+[Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
+
+#### Install Nx Console
+
+Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.
+
+[Install Nx Console &raquo;](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
+
+#### Useful links
+
+Learn more:
+
+- [Learn more about this workspace setup](https://nx.dev/nx-api/expo?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
+- [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
+- [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
+- [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
+
+And join the Nx community:
+
+- [Discord](https://go.nx.dev/community)
+- [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl)
+- [Our Youtube channel](https://www.youtube.com/@nxdevtools)
+- [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) -->
+
+<!-- ## (PROTOTYPE) Themes
 
 ### Colors
 
@@ -780,86 +1059,4 @@ It will show tasks that you can run with Nx.
 
 - [Join the community](https://nx.dev/community)
 - [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools)
-- [Follow us on Twitter](https://twitter.com/nxdevtools)
-
-## NX Notes
-
-<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
-
-✨ Your new, shiny [Nx workspace](https://nx.dev) is almost ready ✨.
-
-[Learn more about this workspace setup and its capabilities](https://nx.dev/nx-api/expo?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed!
-
-### Finish your CI setup
-
-[Click here to finish setting up your workspace!](https://cloud.nx.app/connect/FWnkRYuUP7)
-
-### Run tasks
-
-To run the dev server for your app, use:
-
-```sh
-npx nx serve rufferal
-```
-
-To create a production bundle:
-
-```sh
-npx nx build rufferal
-```
-
-To see all available targets to run for a project, run:
-
-```sh
-npx nx show project rufferal
-```
-
-These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files.
-
-[More about running tasks in the docs &raquo;](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
-
-### Add new projects
-
-While you could add new projects to your workspace manually, you might want to leverage [Nx plugins](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) and their [code generation](https://nx.dev/features/generate-code?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) feature.
-
-Use the plugin's generator to create new projects.
-
-To generate a new application, use:
-
-```sh
-npx nx g @nx/expo:app demo
-```
-
-To generate a new library, use:
-
-```sh
-npx nx g @nx/react:lib mylib
-```
-
-You can use `npx nx list` to get a list of installed plugins. Then, run `npx nx list <plugin-name>` to learn about more specific capabilities of a particular plugin. Alternatively, [install Nx Console](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) to browse plugins and generators in your IDE.
-
-[Learn more about Nx plugins &raquo;](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | [Browse the plugin registry &raquo;](https://nx.dev/plugin-registry?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
-
-[Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
-
-### Install Nx Console
-
-Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.
-
-[Install Nx Console &raquo;](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
-
-### Useful links
-
-Learn more:
-
-- [Learn more about this workspace setup](https://nx.dev/nx-api/expo?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
-- [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
-- [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
-- [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
-
-And join the Nx community:
-
-- [Discord](https://go.nx.dev/community)
-- [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl)
-- [Our Youtube channel](https://www.youtube.com/@nxdevtools)
-- [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)
+- [Follow us on Twitter](https://twitter.com/nxdevtools) -->