d-bis/miracles_in_motion
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
76aa2c72c5b4f64caef989aa0545ef1e8aff85c3
miracles_in_motion/README.md

240 lines
17 KiB
Markdown
Raw Normal View History

feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
<EFBFBD><EFBFBD># Miracles In Motion - Public Web Platform
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
Enterprise-grade, AI-enabled nonprofit platform (public site + portals + real-time services) for Miracles In Motion, a 501(c)3 organization.
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
## <<3C><1F> About Miracles In Motion
Miracles In Motion is a registered 501(c)3 non-profit organization committed to making a meaningful difference in the lives of individuals and families in need. Through our various programs and initiatives, we strive to provide hope, support, and resources to those who need it most.
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
## =؀<> Platform Highlights
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
- **Portals Suite**: Admin, Volunteer, Resource, AI Assistance, Training, Analytics, Mobile Volunteer
- **AI Matching Engine**: Student assistance recommendations with confidence scoring
- **Multi-Language**: 8 languages + RTL support (Arabic)
- **Real-Time Updates**: WebSocket/SignalR for live metrics and request processing
- **PWA & Offline**: Installable app, caching, background sync
- **Performance & SEO**: Optimized bundle, Web Vitals tracking, structured data
- **Scalable Deployment**: Azure Static Web Apps (Standard SKU) + Functions backend
- **Security & Compliance**: Role-based access; future MFA & audit logging roadmap
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
## =<3D><><EFBFBD> Technology Stack
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
- **Frontend**: React 18 + TypeScript + Vite
- **Styling**: Tailwind CSS, Framer Motion animations
- **AI/ML (planned / partial)**: TensorFlow.js models (matching, impact)
- **State & Data**: Context + hooks; CRM connector (Salesforce integration draft)
- **Payments**: Stripe integration (test keys by default)
- **Internationalization**: i18next multi-language framework
- **Deployment**: Azure Static Web Apps (Standard SKU) & Azure Functions
- **Monitoring**: Web Vitals hook; future Application Insights integration
- **Testing**: Vitest + @testing-library/react
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
## =<3D><><EFBFBD> Project Structure
```
miracles_in_motion/
feat: initialize project with Tailwind CSS, React, and TypeScript setup - Added Tailwind CSS configuration with custom theme colors and animations. - Created global styles in index.css including custom scrollbar and button components. - Set up main entry point in main.tsx to render the App component. - Configured TypeScript with strict settings and path mapping. - Added support for high contrast mode and reduced motion in styles. - Included print styles for better printing experience.
2025-10-04 18:11:14 -07:00
%%% README.md # Project documentation
%%% package.json # Dependencies and scripts
%%% tsconfig.json # TypeScript configuration
%%% vite.config.ts # Vite build configuration
%%% tailwind.config.cjs # Tailwind CSS configuration
%%% postcss.config.cjs # PostCSS configuration
%%% .eslintrc.cjs # ESLint configuration
%%% .gitignore # Git ignore rules
%%% .env.example # Environment variables template
%%% index.html # Main HTML entry point
%%% public/ # Static assets
% %%% favicon.svg # Website favicon
% %%% og-image.png # Open Graph image
% %%% robots.txt # Search engine directives
% %%% site.webmanifest # PWA manifest
%%% src/ # Source code
% %%% main.tsx # Vite entry point
% %%% index.css # Global styles & Tailwind
% %%% App.tsx # Complete React application
% %%% assets/ # Static assets for bundling
% % %%% logos/ # Brand assets
% %%% lib/ # Utility libraries
% % %%% analytics.ts # Analytics integration
% % %%% routing.ts # Hash routing utilities
% %%% components/ # Reusable components (optional)
% %%% LogoMark.tsx
% %%% Nav.tsx
% %%% Footer.tsx
% %%% ui/ # Shared UI components
% %%% pages/ # Page components
% %%% HomePage.tsx
% %%% DonatePage.tsx
% %%% VolunteerPage.tsx
% %%% SponsorsPage.tsx
% %%% StoriesPage.tsx
% %%% TestimoniesPage.tsx
% %%% LegalPage.tsx
%%% scripts/ # Build and utility scripts
% %%% generate-og.mjs # Open Graph image generator
%%% assets/ # External assets (not bundled)
% %%% images/ # Photos and graphics
% %%% documents/ # PDFs and legal documents
%%% docs/ # Additional documentation
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
```
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
## <00><> Documentation
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
Central index: `docs/README.md`
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
Key references:
- **QuickStart**: `docs/QuickStart.md`  install, run, test, deploy
- **User Manual**: `docs/UserManual.md`  portals, roles, features
- **Architecture**: `docs/PHASE3_ARCHITECTURE.md`
- **AI Implementation Plan**: `docs/PHASE3_AI_IMPLEMENTATION.md`
- **Performance & SEO**: `docs/PHASE5C_PERFORMANCE_COMPLETE.md`
- **Enterprise Reports**: phase completion & deployment success docs in `docs/`
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
## <00>& Quick Start (Abbreviated)
See full instructions in `docs/QuickStart.md`.
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
```bash
git clone https://github.com/Miracles-In-Motion/public-web.git
cd public-web
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
npm install --legacy-peer-deps
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
npm run dev
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
# visit http://localhost:5173
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
```
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
### Scripts
feat: initialize project with Tailwind CSS, React, and TypeScript setup - Added Tailwind CSS configuration with custom theme colors and animations. - Created global styles in index.css including custom scrollbar and button components. - Set up main entry point in main.tsx to render the App component. - Configured TypeScript with strict settings and path mapping. - Added support for high contrast mode and reduced motion in styles. - Included print styles for better printing experience.
2025-10-04 18:11:14 -07:00
```bash
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
npm run dev # Front-end dev server
npm test # Run test suite
npm run build # Production build (frontend)
npm run preview # Preview build locally
npm run lint # Lint code
node scripts/generate-og.mjs # Generate OG images
feat: initialize project with Tailwind CSS, React, and TypeScript setup - Added Tailwind CSS configuration with custom theme colors and animations. - Created global styles in index.css including custom scrollbar and button components. - Set up main entry point in main.tsx to render the App component. - Configured TypeScript with strict settings and path mapping. - Added support for high contrast mode and reduced motion in styles. - Included print styles for better printing experience.
2025-10-04 18:11:14 -07:00
```
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
### Building for Production
```bash
feat: initialize project with Tailwind CSS, React, and TypeScript setup - Added Tailwind CSS configuration with custom theme colors and animations. - Created global styles in index.css including custom scrollbar and button components. - Set up main entry point in main.tsx to render the App component. - Configured TypeScript with strict settings and path mapping. - Added support for high contrast mode and reduced motion in styles. - Included print styles for better printing experience.
2025-10-04 18:11:14 -07:00
# Full production build
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
npm run build
feat: initialize project with Tailwind CSS, React, and TypeScript setup - Added Tailwind CSS configuration with custom theme colors and animations. - Created global styles in index.css including custom scrollbar and button components. - Set up main entry point in main.tsx to render the App component. - Configured TypeScript with strict settings and path mapping. - Added support for high contrast mode and reduced motion in styles. - Included print styles for better printing experience.
2025-10-04 18:11:14 -07:00
# The built files will be in the `dist/` directory
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
```
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
### Azure Deployment (Standard SKU)
Refer to `docs/QuickStart.md` for full flow.
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
```bash
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
az login
az group create --name rg-mim-prod --location eastus2
az staticwebapp create \
--name mim-prod-web-standard \
--resource-group rg-mim-prod \
--location eastus2 \
--source . \
--branch main \
--app-location / \
--output-location dist
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
```
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
## =<3D><><EFBFBD> Core Portals & Features
| Portal | Purpose |
|--------|---------|
| Admin | Oversight, approvals, metrics |
| Volunteer | Assignments, status updates |
| Resource | Student assistance matching |
| AI Assistance | Recommendations + confidence |
| Staff Training | Module progress & badges |
| Analytics | KPIs, trends, predictive insights |
| Mobile Volunteer | Touch-optimized PWA workflow |
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
## <ب<> Customization
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
- Content & layout adjustments: `src/` (pages, components)
- Branding assets: `assets/images/`, `public/`
- Routing additions: update navigation + portal components
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
## =<3D>'<27> Configuration
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
Environment variables (example) in `.env.local`:
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
```env
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
VITE_API_BASE=/api
VITE_STRIPE_PUBLISHABLE_KEY=pk_test_xxx
VITE_DEFAULT_LANGUAGE=en
VITE_SUPPORTED_LANGUAGES=en,es,fr,de,zh,ar,pt,ru
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
```
### Analytics
Google Analytics is integrated and ready to track:
- Page views
- Donation conversions
- Volunteer sign-ups
- Contact form submissions
## =<3D><><EFBFBD> Mobile Optimization
The site is fully responsive with:
- Mobile-first design approach
- Touch-friendly navigation
- Optimized images for different screen sizes
- Fast loading times on mobile networks
## & Accessibility
We're committed to accessibility:
- ARIA labels and roles
- Keyboard navigation support
- High contrast mode compatibility
- Screen reader optimization
- Alt text for all images
## ><3E><1D> Contributing
We welcome contributions! Please:
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly
5. Submit a pull request
## =<3D><><EFBFBD> Support
feat: Complete Phase 5C and Phase 5D documentation, including performance metrics, SEO optimization, and advanced features implementation docs: Add production deployment success documentation for Azure Static Web App docs: Create Quick Start guide for project setup and deployment instructions docs: Update README.md to include new documentation links and structure docs: Enhance User Manual with detailed portal access, roles, and AI assistance features scripts: Implement architecture diagram export script using Mermaid CLI scripts: Create script to auto-generate documentation index for easier navigation chore: Remove unused update-doc-index script
2025-11-11 09:07:28 -08:00
Questions / issues:
- Email: contact@mim4u.org
- GitHub Issues: https://github.com/Miracles-In-Motion/public-web/issues
feat: Add contributing guidelines, license, and security policy documents - Created CONTRIBUTING.md to outline contribution process and code of conduct. - Added LICENSE file with MIT License and third-party licenses. - Introduced SECURITY.md detailing vulnerability reporting and security measures. - Established README.md in assets directory for asset management and guidelines. - Implemented index.html as the main entry point for the website. - Configured package.json for project dependencies and scripts. - Developed styles.css for custom styles and responsive design. - Set up vite.config.ts for Vite configuration and build settings.
2025-10-04 17:46:58 -07:00
## =<3D><><EFBFBD> Legal
### 501(c)3 Status
Miracles In Motion is a registered 501(c)3 non-profit organization.
- EIN: [Your EIN Number]
- State Registration: [Your State Registration]
### Privacy Policy
We are committed to protecting your privacy. See our full [Privacy Policy](assets/documents/privacy-policy.pdf).
### Terms of Service
By using this website, you agree to our [Terms of Service](assets/documents/terms-of-service.pdf).
## =<3D><><EFBFBD> Performance
The website is optimized for:
- **Page Speed**: <3 second load times
- **SEO**: Structured data and meta optimization
- **Lighthouse Score**: 90+ across all metrics
- **Core Web Vitals**: Excellent ratings
## =<3D><04> Updates & Maintenance
- **Content Updates**: Monthly review of all content
- **Security Updates**: Quarterly security audits
- **Performance Monitoring**: Continuous monitoring
- **Backup Strategy**: Daily automated backups
---
## =ؖ<> Our Mission
*"At Miracles In Motion, we believe that every act of kindness creates a ripple effect of positive change. Through compassionate action and community support, we work to transform lives and build a better tomorrow for all."*
---
**Miracles In Motion** | 501(c)3 Non-Profit Organization
Creating Hope " Inspiring Change " Building Community
chore: comprehensive project update with dependency modernization, contact information standardization, copyright updates, and build configuration improvements - Updated dependencies to latest compatible versions including React, TypeScript, and Vite. - Standardized contact information across all components (phone, email, address, EIN). - Updated copyright year to 2025 and ensured consistent legal status messaging. - Modernized Azure infrastructure with updated API versions and enhanced security practices. - Optimized build configurations for TypeScript and Vite, ensuring production readiness. - Cleaned up console logs and improved code quality with type safety and test coverage updates.
2025-10-05 19:41:51 -07:00
<00> 2025 Miracles In Motion. All rights reserved.
Reference in New Issue Copy Permalink