|
| 1 | +# Elmentor Landing Page |
| 2 | + |
| 3 | +A clean, maintainable landing page for the Elmentor/DevOps Visions community built with React, TypeScript, and Vite. |
| 4 | + |
| 5 | +[](https://github.com/DevOpsVisions/elmentor-landing-page-clean) |
| 6 | +[](https://opensource.org/licenses/MIT) |
| 7 | + |
| 8 | +> **CRITICAL NOTE**: This repository contains the GitHub Pages website serving as the landing page for our community. The website content and functionality (src/, public/, build config, deployment scripts) must be preserved at all costs. See [Contributing Guidelines](CONTRIBUTING.md) for more details. |
| 9 | +
|
| 10 | +## 📋 Quick Start |
| 11 | + |
| 12 | +`ash |
| 13 | +# Install dependencies |
| 14 | +npm install |
| 15 | + |
| 16 | +# Start development server |
| 17 | +npm run dev |
| 18 | + |
| 19 | +# Build for production |
| 20 | +npm run build |
| 21 | + |
| 22 | +# Preview production build |
| 23 | +npm run serve |
| 24 | +` |
| 25 | + |
| 26 | +## 🚀 Deployment |
| 27 | + |
| 28 | +To deploy to GitHub Pages: |
| 29 | + |
| 30 | +1. Update your GitHub username in \github-config.txt\ |
| 31 | +2. Run the deployment script: |
| 32 | + `ash |
| 33 | + # PowerShell (recommended) |
| 34 | + ./deploy.ps1 |
| 35 | + |
| 36 | + # Or using npm |
| 37 | + npm run deploy |
| 38 | + ` |
| 39 | + |
| 40 | +## 🛠️ Project Structure |
| 41 | + |
| 42 | +` |
| 43 | +elmentor-landing-page-clean/ |
| 44 | +├── dist/ # Build output |
| 45 | +├── docs/ # Documentation |
| 46 | +│ ├── deployment/ # Deployment documentation |
| 47 | +│ ├── development/ # Development guides |
| 48 | +│ └── devops-visions-guidance/ # DevOps Visions standards |
| 49 | +├── public/ # Static assets [DO NOT MODIFY] |
| 50 | +├── scripts/ # Utility scripts |
| 51 | +│ ├── deployment/ # Deployment scripts [DO NOT MODIFY] |
| 52 | +│ ├── maintenance/ # Maintenance scripts |
| 53 | +│ └── utils/ # Utility scripts |
| 54 | +├── .github/ # GitHub templates and workflows |
| 55 | +│ ├── ISSUE_TEMPLATE/ # Issue templates |
| 56 | +│ └── PULL_REQUEST_TEMPLATE/ # PR templates |
| 57 | +├── .temp/ # Untracked local development files (not in Git) |
| 58 | +└── src/ # Source code [DO NOT MODIFY] |
| 59 | +` |
| 60 | + |
| 61 | +## 🧩 Features |
| 62 | + |
| 63 | +- Modern React with TypeScript |
| 64 | +- Fast builds with Vite |
| 65 | +- Responsive design |
| 66 | +- Framer Motion animations |
| 67 | +- GitHub Pages deployment |
| 68 | + |
| 69 | +## 🧰 Maintenance |
| 70 | + |
| 71 | +For repository maintenance tasks: |
| 72 | + |
| 73 | +`ash |
| 74 | +./maintain.ps1 |
| 75 | +` |
| 76 | + |
| 77 | +## 🔧 Development Utilities |
| 78 | + |
| 79 | +For local development files that shouldn't be committed: |
| 80 | + |
| 81 | +`ash |
| 82 | +# Move or copy files to untracked .temp directory |
| 83 | +./move-to-temp.ps1 |
| 84 | +` |
| 85 | + |
| 86 | +The \.temp\ directory is ignored by Git and provides a standardized location for: |
| 87 | +- Development scripts |
| 88 | +- Documentation drafts |
| 89 | +- Temporary build outputs |
| 90 | +- Work-in-progress files |
| 91 | + |
| 92 | +## 📚 Documentation |
| 93 | + |
| 94 | +For detailed documentation, see the \docs\ directory: |
| 95 | + |
| 96 | +- [Deployment Guide](docs/deployment/README.md) |
| 97 | +- [Development Maintenance](docs/development/maintenance.md) |
| 98 | +- [DevOps Visions Standards](docs/devops-visions-guidance/standards-and-conventions.md) |
| 99 | +- [Contributing Guidelines](CONTRIBUTING.md) |
| 100 | +- [Code of Conduct](CODE_OF_CONDUCT.md) |
| 101 | + |
| 102 | +## 🤝 Contributing |
| 103 | + |
| 104 | +Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before submitting a pull request. |
| 105 | + |
| 106 | +**IMPORTANT**: Any changes to the website code, structure, or deployment configuration are subject to strict review and must follow the special guidelines in the contributing document. |
| 107 | + |
| 108 | +## 📄 License |
| 109 | + |
| 110 | +This project is licensed under the MIT License. |
0 commit comments