Remove secrets from repository before open sourcing

.env.example

@@ -0,0 +1,5 @@
+# Copy this file to .env and fill in your values
+# DO NOT commit the .env file to version control
+
+# KinesteX API Key - Get this from your KinesteX account
+KINESTEX_KEY=your_kinestex_api_key_here

.gitignore

@@ -63,6 +63,15 @@ amplifytools.xcconfig
 amplifyconfiguration*
 #amplify-do-not-edit-end
 
+# Environment files with secrets
+.env
+.env.local
+.env.*.local
+
+# Amplify outputs (contain AWS resource IDs)
+amplify_outputs.json
+lib/amplify_outputs.dart
+
 # FVM Version Cache
 .fvm/
 

README.md

@@ -34,6 +34,36 @@ flutter pub get
 cd ios && pod install && cd ..
 ```
 
+**Configuration**
+
+Before running the application, you need to set up your configuration files:
+
+1. **Environment Variables**: Copy `.env.example` to `.env` and fill in your API keys:
+   ```
+   cp .env.example .env
+   ```
+   Then edit `.env` with your KinesteX API key.
+
+2. **AWS Amplify Configuration**: You have two options:
+
+   **Option A - Using Amplify CLI (Recommended for new deployments):**
+   ```
+   npx ampx sandbox --outputs-format dart --outputs-out-dir lib
+   ```
+   This will create `amplify_outputs.json` and `lib/amplify_outputs.dart` with your AWS resources.
+
+   **Option B - Manual configuration (For existing deployments):**
+   Copy `amplify_outputs.example.json` to `amplify_outputs.json` and fill in your AWS resource IDs:
+   ```
+   cp amplify_outputs.example.json amplify_outputs.json
+   ```
+   Then copy `lib/amplify_outputs.dart.example` to `lib/amplify_outputs.dart` and fill in the same values:
+   ```
+   cp lib/amplify_outputs.dart.example lib/amplify_outputs.dart
+   ```
+
+> **Important**: Never commit `.env`, `amplify_outputs.json`, or `lib/amplify_outputs.dart` to version control as they contain sensitive credentials.
+
 **Build & Run**
 
 - Create the build artifact for the iOS platform

amplify_outputs.example.json

@@ -0,0 +1,49 @@
+{
+  "auth": {
+    "user_pool_id": "your-region_XXXXXXXXX",
+    "aws_region": "us-east-1",
+    "user_pool_client_id": "your_client_id_here",
+    "identity_pool_id": "your-region:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    "mfa_methods": [],
+    "standard_required_attributes": [
+      "email"
+    ],
+    "username_attributes": [
+      "email"
+    ],
+    "user_verification_types": [
+      "email"
+    ],
+    "groups": [
+      {
+        "admin": {
+          "precedence": 0
+        }
+      }
+    ],
+    "mfa_configuration": "NONE",
+    "password_policy": {
+      "min_length": 8,
+      "require_lowercase": true,
+      "require_numbers": true,
+      "require_symbols": true,
+      "require_uppercase": true
+    },
+    "unauthenticated_identities_enabled": true
+  },
+  "data": {
+    "url": "https://your-appsync-api-id.appsync-api.your-region.amazonaws.com/graphql",
+    "aws_region": "us-east-1",
+    "default_authorization_type": "AMAZON_COGNITO_USER_POOLS",
+    "authorization_types": [
+      "AWS_IAM"
+    ],
+    "model_introspection": {
+      "version": 1,
+      "models": {},
+      "enums": {},
+      "nonModels": {}
+    }
+  },
+  "version": "1.3"
+}