Merge branch 'main' of github.com:ModusCreateOrg/app-med-ai-gen into ADE-150-API-configuration

Author: GuidoBR

.cursor/rules/aws-amplify-best-practices.mdc

@@ -0,0 +1,9 @@
+---
+description: 
+globs: *.ts,*.tsx
+alwaysApply: false
+---
+- Use Amplify CLI for easy setup and configuration
+- Implement proper authentication flows with Amplify Auth
+- Utilize Amplify DataStore for offline capabilities
+- Optimize API calls with Amplify's GraphQL client

.cursor/rules/axios-best-practices.mdc

@@ -0,0 +1,9 @@
+---
+description: 
+globs: *.ts,*.tsx
+alwaysApply: false
+---
+- Use interceptors for global request/response handling
+- Implement proper error handling and status code checks
+- Utilize Axios' cancel token for aborting requests
+- Set up default configurations for common headers and base URL

.cursor/rules/capacitor-best-practices.mdc

@@ -0,0 +1,9 @@
+---
+description: 
+globs: *.ts,*.tsx
+alwaysApply: false
+---
+- Use Capacitor plugins for native functionality
+- Implement proper lifecycle management for mobile apps
+- Optimize app size by selectively including plugins
+- Use Capacitor's storage API for local data persistence

.cursor/rules/formik-best-practices.mdc

@@ -0,0 +1,9 @@
+---
+description: 
+globs: *.ts,*.tsx
+alwaysApply: false
+---
+- Use Formik's built-in validation for form handling
+- Implement custom validation with Yup for complex schemas
+- Utilize the useFormik hook for more control over form state
+- Leverage Formik's error handling for user feedback

.cursor/rules/general.mdc

@@ -1,8 +1,8 @@
 ---
-description: Follow this rules for every request
+description: 
 globs: 
+alwaysApply: true
 ---
-
 - Project Proposal Overview: This project proposes an AI-powered medical report translator that simplifies complex medical documents for patients and caregivers. By leveraging AI-driven text extraction and natural language processing (NLP), the system translates medical jargon into plain language, helping users understand their health conditions, diagnoses, and test results without relying on unreliable online searches.
 
 - Why are we doing this? Patients often receive medical reports full of complex terminology, abbreviations, and technical language that they don’t understand, causing confusion, stress, and potential misinterpretation of their health conditions. Many resort to Google searches or unreliable forums to decipher their reports, leading to misinformation and anxiety. By automating medical report simplification, we help patients take control of their healthcare, make informed decisions, and reduce the dependency on doctors for basic explanations.
@@ -67,7 +67,10 @@ Technologies:
 [5 - Results analysis.png](mdc:docs/assets/images/5 - Results analysis.png)
 [6 - Results Archive.png](mdc:docs/assets/images/6 - Results Archive.png)
 [7 - Detail.png](mdc:docs/assets/images/7 - Detail.png)
-
+[Upload_default.png](mdc:docs/assets/images/Upload_default.png)
+[Upload_success.png](mdc:docs/assets/images/Upload_success.png)
+[Uploading.png](mdc:docs/assets/images/Uploading.png)
+[Uploading_complete.png](mdc:docs/assets/images/Uploading_complete.png)
 
 AWS architecture: [aws architecture.pdf](mdc:docs/assets/aws architecture.pdf)
 
@@ -121,10 +124,37 @@ AWS architecture: [aws architecture.pdf](mdc:docs/assets/aws architecture.pdf)
 ```
 ```
 
+# General Code Guidelines
+
+## Category Determination Pattern
+When determining categories based on keywords in filenames or text:
+
+1. Define a constant mapping object at module level that maps categories to their identifying keywords
+2. Use TypeScript's Record type to ensure type safety
+3. Convert input to lowercase once at the start
+4. Use Array methods like `find` and `some` for clean keyword matching
+5. Provide a default/fallback category
+6. Include JSDoc with clear parameter and return descriptions
+
+Example:
+```typescript
+const CATEGORY_KEYWORDS: Record<Category, string[]> = {
+  [Category.TYPE_A]: ['keyword1', 'keyword2'],
+  [Category.TYPE_B]: ['keyword3', 'keyword4'],
+  [Category.DEFAULT]: []
+};
+
+const determineCategory = (input: string): Category => {
+  const lowerInput = input.toLowerCase();
+  const matchedCategory = Object.entries(CATEGORY_KEYWORDS)
+    .find(([_, keywords]) => keywords.some(k => lowerInput.includes(k)));
+  return matchedCategory ? (matchedCategory[0] as Category) : Category.DEFAULT;
+};
+``` 
+
 # Typescript rules
 
 - Prefer using nullish coalescing operator (`??`) instead of a logical or (`||`), as it is a safer operator.
 
 This rule provides clear guidelines on what units to use, how to convert between units, and why it's important for your project. You can add this to your general rules to ensure consistency across the codebase.
 
-Prefer using nullish coalescing operator (`??`) instead of a logical or (`||`), as it is a safer operator.

.cursor/rules/ionic-best-practices.mdc

@@ -0,0 +1,10 @@
+---
+description: 
+globs: *.ts,*.tsx,*.scss
+alwaysApply: false
+---
+- Use Ionic components for a consistent UI across platforms
+- Leverage Ionic's navigation system for routing
+- Optimize performance with lazy loading of pages
+- Use Ionic's theming system for easy customization
+

.cursor/rules/react-best-practices.mdc

@@ -0,0 +1,9 @@
+---
+description: 
+globs: *.ts,*.tsx
+alwaysApply: false
+---
+- Use functional components with hooks instead of class components
+- Implement proper state management (e.g., Context API, Redux)
+- Utilize memoization techniques (useMemo, useCallback) for performance
+- Follow React's one-way data flow principle

.cursor/rules/react-router-best-practices.mdc

@@ -0,0 +1,9 @@
+---
+description: 
+globs: *.ts,*.tsx
+alwaysApply: false
+---
+- Use declarative routing with Route components
+- Implement nested routes for better organization
+- Utilize the useParams hook for dynamic routing
+- Use the useHistory hook for programmatic navigation

.cursor/rules/typescript-best-practices.mdc

@@ -0,0 +1,10 @@
+---
+description: 
+globs: *.ts,*.tsx
+alwaysApply: false
+---
+- Use strict null checks
+- Prefer interface over type when possible
+- Utilize type guards and assertions for runtime type checking
+- Implement proper type inference to reduce explicit type annotations
+- Prefer using nullish coalescing operator (`??`) instead of a logical or (`||`), as it is a safer operator.

.cursorrules

@@ -0,0 +1,30 @@
+# Cursor Rules
+
+## Always Use i18n for Text in React Files
+
+Always use the internationalization (i18n) system for any text displayed to users in React components.
+
+```typescript
+// ❌ AVOID hardcoded text
+<label>Email</label>
+<span>Don't have an account?</span>
+<button>Log in</button>
+
+// ✅ PREFERRED - Use t() function from react-i18next
+<label>{t('label.email', { ns: 'auth' })}</label>
+<span>{t('no-account', { ns: 'auth' })}</span>
+<button>{t('signin', { ns: 'auth' })}</button>
+```
+
+### Translation Key Guidelines:
+- Use namespaces to organize translations (e.g., { ns: 'auth' })
+- Use hierarchical keys with dots for organization (e.g., 'label.email')
+- Ensure all keys are defined in the appropriate translation files
+
+### Common Namespaces:
+- 'common' - app-wide common labels and messages
+- 'auth' - authentication related texts
+- 'errors' - error messages
+- 'validation' - form validation messages
+
+This rule ensures our application supports multiple languages and facilitates future translations.