Skip to content

Commit

Permalink
docs: update repository context via Repomix [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 17, 2025
1 parent 90de8d9 commit cac9b03
Showing 1 changed file with 77 additions and 69 deletions.
146 changes: 77 additions & 69 deletions DOCS/repository_context.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This file is a merged representation of the entire codebase, combining all repository files into a single document.
Generated by Repomix on: 2025-01-17T04:32:12.483Z
Generated by Repomix on: 2025-01-17T04:33:46.296Z

# File Summary

Expand Down Expand Up @@ -13178,75 +13178,83 @@ tsconfig.json
70: - React Hook Form with Typescript and Zod for efficient form handling and validation
71: - Reusable GenericForm component for easy form creation and management
72: - Error handling with react-error-boundary for improved user experience and easier debugging
73:
74: ### Design
75:
76: - Fully responsive design tested on all devices
77: - React Icons for project icons
78: - Tailwind CSS for styling
79: - Animated reusable input fields
80: - Matrix-inspired animated cursor with dynamic trailing effect with fading Matrix characters
81:
82: ### Accessibility
83:
84: - WCAG accessibility tested
85: - Accessibility testing with Cypress Axe
86: - Builds will fail if any a11y errors are found
87:
88: ### Devops and Code quality
89:
90: - Continuous Integration with CircleCI
91: - CircleCI will warn before deploy if tests fail (setup for React testing library)
92: - Github action workflow for Cypress
93: - Code quality analysis with Codacy, Sonarcloud and Codeclimate
94: - E2E testing with Cypress and Playwright integrated with Github actions
95: - Unit testing with Jest and React Testing Library integrated with CircleCI
96: - Test coverage setup with Codecov
97: - 100% test coverage with Jest and React testing library
98: - AI-powered commit message generation following Conventional Commits with gitmojis
99: - Automated performance monitoring with Lighthouse CI
100: - Performance, accessibility, best practices, and SEO checks on every PR
101: - Configurable thresholds for quality metrics
102: - Both desktop and performance-focused testing
103:
104: ### Environment Variables
105:
106: - Type-safe environment variable validation with envalid
107: - Runtime validation of required environment variables
108: - Clear error messages with examples for missing variables
109: - Separate handling of client-side and server-side variables
110: - Default values where appropriate
111: - Required variables:
112: ```env
113: # Email Configuration (client-side)
114: NEXT_PUBLIC_EMAIL_API_KEY=user_xxx # EmailJS API key
115: NEXT_PUBLIC_EMAIL_TEMPLATE_KEY=template_xxx # EmailJS template key
116: NEXT_PUBLIC_EMAIL_SERVICE_KEY=service_xxx # EmailJS service key
117:
118: # AI Configuration (server-side)
119: AI_API_KEY=xxx # AI service API key
120: AI_BASE_URL=https://xxx # AI service base URL
121: MODEL_NAME=claude-3.5-sonnet@anthropic # Optional, has default value
122: ```
123: - Validation prevents application startup if required variables are missing
124: - TypeScript integration for type-safe access to environment variables
73: - AI-friendly repository documentation with automated updates
74:
75: ### Design
76:
77: - Fully responsive design tested on all devices
78: - React Icons for project icons
79: - Tailwind CSS for styling
80: - Animated reusable input fields
81: - Matrix-inspired animated cursor with dynamic trailing effect with fading Matrix characters
82:
83: ### Accessibility
84:
85: - WCAG accessibility tested
86: - Accessibility testing with Cypress Axe
87: - Builds will fail if any a11y errors are found
88:
89: ### Devops and Code quality
90:
91: - Continuous Integration with CircleCI
92: - CircleCI will warn before deploy if tests fail (setup for React testing library)
93: - Github action workflow for Cypress
94: - Code quality analysis with Codacy, Sonarcloud and Codeclimate
95: - E2E testing with Cypress and Playwright integrated with Github actions
96: - Unit testing with Jest and React Testing Library integrated with CircleCI
97: - Test coverage setup with Codecov
98: - 100% test coverage with Jest and React testing library
99: - AI-powered commit message generation following Conventional Commits with gitmojis
100: - Automated performance monitoring with Lighthouse CI
101: - Performance, accessibility, best practices, and SEO checks on every PR
102: - Configurable thresholds for quality metrics
103: - Both desktop and performance-focused testing
104: - Automated repository documentation with Repomix
105: - AI-friendly documentation generation on every push to main
106: - Comprehensive repository context maintained in DOCS/repository_context.txt
107: - Automated PR analysis with repository structure insights
108: - Security-focused documentation with sensitive information filtering
109: - Markdown formatting for improved readability
110: - Automated comments on PRs with codebase context
111:
112: ### Environment Variables
113:
114: - Type-safe environment variable validation with envalid
115: - Runtime validation of required environment variables
116: - Clear error messages with examples for missing variables
117: - Separate handling of client-side and server-side variables
118: - Default values where appropriate
119: - Required variables:
120: ```env
121: # Email Configuration (client-side)
122: NEXT_PUBLIC_EMAIL_API_KEY=user_xxx # EmailJS API key
123: NEXT_PUBLIC_EMAIL_TEMPLATE_KEY=template_xxx # EmailJS template key
124: NEXT_PUBLIC_EMAIL_SERVICE_KEY=service_xxx # EmailJS service key
125:
126: ### Testing Standards
127:
128: - Enforced AAA (Arrange-Act-Assert) pattern in all test files
129: - Each test must include the following comments:
130: ```typescript
131: // Arrange - Set up test data and conditions
132: // Act - Perform the action being tested
133: // Assert - Verify the results
134: ```
135: - This pattern ensures:
136: - Clear test structure and readability
137: - Consistent test organization across the codebase
138: - Easy identification of test setup, execution, and verification
139: - Simplified test maintenance and debugging
140: - Automated validation through custom ESLint rules
141: - Tests will fail if AAA pattern is not followed
126: # AI Configuration (server-side)
127: AI_API_KEY=xxx # AI service API key
128: AI_BASE_URL=https://xxx # AI service base URL
129: MODEL_NAME=claude-3.5-sonnet@anthropic # Optional, has default value
130: ```
131: - Validation prevents application startup if required variables are missing
132: - TypeScript integration for type-safe access to environment variables
133:
134: ### Testing Standards
135:
136: - Enforced AAA (Arrange-Act-Assert) pattern in all test files
137: - Each test must include the following comments:
138: ```typescript
139: // Arrange - Set up test data and conditions
140: // Act - Perform the action being tested
141: // Assert - Verify the results
142: ```
143: - This pattern ensures:
144: - Clear test structure and readability
145: - Consistent test organization across the codebase
146: - Easy identification of test setup, execution, and verification
147: - Simplified test maintenance and debugging
148: - Automated validation through custom ESLint rules
149: - Tests will fail if AAA pattern is not followed
```

## File: renovate.json
Expand Down

0 comments on commit cac9b03

Please sign in to comment.