110 lines
3.3 KiB
Bash
Executable file
110 lines
3.3 KiB
Bash
Executable file
#!/bin/bash
|
||
|
||
cat > README.md << 'EOL'
|
||
# DeafGain LLC Website 🌐
|
||
|
||
[](https://pnpm.io/)
|
||
[](https://www.typescriptlang.org/)
|
||
[](https://reactjs.org/)
|
||
|
||
## Overview
|
||
|
||
A dynamic web platform dedicated to empowering the Deaf community through innovative communication solutions, training, and accessibility services. This website serves as the digital presence for DeafGain LLC, showcasing our comprehensive services including ADA-compliant transcripts, universal website design, board communication protocols, and leadership training.
|
||
|
||
## 🚀 Quick Start
|
||
|
||
\`\`\`bash
|
||
pnpm install
|
||
pnpm dev
|
||
\`\`\`
|
||
|
||
Visit \`localhost:3000\` in your browser.
|
||
|
||
## 🛠 Technical Stack
|
||
|
||
| Technology | Version | Purpose |
|
||
|------------|---------|---------|
|
||
| React | 18.2.0 | Core Framework |
|
||
| TypeScript | 4.9.5 | Type Safety |
|
||
| Tailwind CSS | 3.x | Styling |
|
||
| Framer Motion | 10.x | Animations |
|
||
| React Simple Maps | 3.0.0 | Geographic Visualization |
|
||
| Vite | 4.x | Build System |
|
||
| Docker | - | Containerization |
|
||
| Nginx | - | Web Server |
|
||
|
||
## 📁 Project Structure
|
||
|
||
\`\`\`
|
||
src/
|
||
├── components/ # Reusable UI components
|
||
│ ├── layout/ # Layout components
|
||
│ ├── ui/ # UI elements
|
||
│ └── maps/ # Map visualization components
|
||
├── pages/ # Main application pages
|
||
├── hooks/ # Custom React hooks
|
||
├── utils/ # Utility functions
|
||
├── types/ # TypeScript definitions
|
||
├── assets/ # Static assets
|
||
└── styles/ # Global styles
|
||
\`\`\`
|
||
|
||
## 🎯 Core Features
|
||
|
||
- ⚡️ Intuitive user interface with responsive design
|
||
- 🗺️ Interactive USA region map displaying network and relationships
|
||
- 🎥 Video resources with accessible playback controls and captions
|
||
- 📱 Mobile-first responsive design
|
||
- 🔒 Secure contact system
|
||
- 🌐 Key sections: Home, Services, About, Resources, and Contact
|
||
|
||
## 🔧 Development
|
||
|
||
### Environment Setup
|
||
- Development: Vite dev server with hot reload
|
||
- Production: Nginx configuration with optimized cache settings
|
||
- Docker containers for consistent deployment
|
||
|
||
### Scripts
|
||
\`\`\`bash
|
||
pnpm dev # Start development server
|
||
pnpm build # Build for production
|
||
pnpm preview # Preview production build
|
||
pnpm lint # Run ESLint
|
||
pnpm test # Run tests
|
||
\`\`\`
|
||
|
||
## 🚢 Production Deployment
|
||
|
||
\`\`\`bash
|
||
docker-compose up --build
|
||
\`\`\`
|
||
|
||
Application will be served on port 80.
|
||
|
||
## <20><> Contributing
|
||
|
||
We welcome contributions that align with our mission of improving accessibility and empowerment for the Deaf community. Follow our established patterns for:
|
||
|
||
- Component architecture
|
||
- Styling conventions (Tailwind CSS)
|
||
- Accessibility standards (WCAG 2.1)
|
||
- TypeScript typing
|
||
- Git commit messages
|
||
|
||
## 📄 License
|
||
|
||
Proprietary - DeafGain LLC
|
||
|
||
## 📞 Contact
|
||
|
||
For questions or support, reach out through our [contact form](https://deafgain.com/contact).
|
||
|
||
---
|
||
|
||
> This website represents DeafGain LLC's commitment to creating accessible, user-friendly digital experiences while maintaining high technical standards and professional quality.
|
||
EOL
|
||
|
||
chmod +x create-readme.sh
|
||
echo "README.md has been created successfully!"
|
||
|