Switch from github
This commit is contained in:
parent
80b8200fc2
commit
0b10547bd5
7 changed files with 189 additions and 57 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -35,5 +35,3 @@ yarn-error.log*
|
|||
|
||||
# TypeScript
|
||||
*.tsbuildinfo
|
||||
public/videos/
|
||||
public/images/
|
||||
|
|
|
|||
134
README.md
134
README.md
|
|
@ -1,78 +1,102 @@
|
|||
# DeafGain LLC Website
|
||||
# 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.
|
||||
|
||||
## Core Features
|
||||
## 🚀 Quick Start
|
||||
|
||||
Intuitive user interface with responsive design
|
||||
Interactive USA region map displaying network and relationships
|
||||
Video resources with accessible playback controls and captions
|
||||
Detailed service descriptions
|
||||
Secure contact system
|
||||
Key sections: Home, Services, About, Resources, and Contact
|
||||
Technical Stack
|
||||
React 18 with TypeScript
|
||||
Tailwind CSS for styling
|
||||
Framer Motion for animations
|
||||
React Simple Maps for geographic visualization
|
||||
Vite build system
|
||||
Docker containerization
|
||||
Nginx web server
|
||||
\`\`\`bash
|
||||
pnpm install
|
||||
pnpm dev
|
||||
\`\`\`
|
||||
|
||||
## Quick Start
|
||||
Visit \`localhost:3000\` in your browser.
|
||||
|
||||
### Development
|
||||
## 🛠 Technical Stack
|
||||
|
||||
```
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
| 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 |
|
||||
|
||||
Visit localhost:3000 in your browser.
|
||||
## 📁 Project Structure
|
||||
|
||||
### Production Deployment
|
||||
\`\`\`
|
||||
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
|
||||
|
||||
## Project Structure
|
||||
We welcome contributions that align with our mission of improving accessibility and empowerment for the Deaf community. Follow our established patterns for:
|
||||
|
||||
```
|
||||
src/
|
||||
├── components/ # Reusable UI components
|
||||
├── pages/ # Main application pages
|
||||
├── assets/ # Static assets
|
||||
public/
|
||||
├── images/ # Image assets
|
||||
├── videos/ # Video content
|
||||
├── subtitles/ # Video captions
|
||||
├── transcriptions/# Text transcripts
|
||||
```
|
||||
- Component architecture
|
||||
- Styling conventions (Tailwind CSS)
|
||||
- Accessibility standards (WCAG 2.1)
|
||||
- TypeScript typing
|
||||
- Git commit messages
|
||||
|
||||
# Environment Setup
|
||||
## 📄 License
|
||||
|
||||
Development: Uses Vite dev server with hot reload
|
||||
Production: Nginx configuration with optimized cache settings
|
||||
Docker containers for consistent deployment
|
||||
|
||||
# Contributing
|
||||
|
||||
We welcome contributions that align with our mission of improving accessibility and empowerment for the Deaf community. Follow the established patterns for:
|
||||
|
||||
Component architecture
|
||||
Styling conventions
|
||||
Accessibility standards
|
||||
TypeScript typing
|
||||
License
|
||||
Proprietary - DeafGain LLC
|
||||
|
||||
# Contact
|
||||
## 📞 Contact
|
||||
|
||||
For questions or support, reach out through our contact form.
|
||||
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.
|
||||
---
|
||||
|
||||
> This website represents DeafGain LLC's commitment to creating accessible, user-friendly digital experiences while maintaining high technical standards and professional quality.
|
||||
|
|
|
|||
110
create-readme.sh
Executable file
110
create-readme.sh
Executable file
|
|
@ -0,0 +1,110 @@
|
|||
#!/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!"
|
||||
|
||||
BIN
public/images/eliza-old.jpg
Normal file
BIN
public/images/eliza-old.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 115 KiB |
BIN
public/images/eliza.jpg
Normal file
BIN
public/images/eliza.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 364 KiB |
BIN
public/images/scene.jpg
Normal file
BIN
public/images/scene.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 941 KiB |
BIN
public/images/thumbnails/minutes-approval-procedure.png
Normal file
BIN
public/images/thumbnails/minutes-approval-procedure.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.3 MiB |
Loading…
Add table
Reference in a new issue