Get instant insights about your website's performance, security, and SEO. Make your website ready for success with ChecKly.
ChecKly Dashboard - Comprehensive Website Analysis Interface
- ✨ Features
- 🚀 Quick Start
- 📦 Installation
- ⚙️ Configuration
- 🎯 Usage
- 🏗️ Project Structure
- 🤝 Contributing
- 💡 Feature Ideas
- 📄 License
- 👥 Team
- Security Check 🔒 - Analyze SSL certificates, security headers, and vulnerabilities
- Performance Test ⚡ - Check loading speed, Core Web Vitals, and optimization opportunities
- SEO Analysis 📈 - Get detailed insights about search engine optimization
- Smart Insights 🤖 - Personalized recommendations powered by advanced AI
- Actionable Suggestions 💡 - Specific improvements for each category
- Priority-based Actions 🎯 - High, medium, and low priority recommendations
- Real-time Results 📱 - Instant analysis with beautiful visualizations
- Category Breakdown 📋 - Detailed insights for SEO, Performance, and Security
- Export Reports 📄 - Download comprehensive analysis reports
- Secure Sign-in 🔑 - Firebase authentication for personalized experience
- User Profiles 👤 - Save and manage your analysis history
- Protected Features 🛡️ - AI recommendations require authentication
- Node.js (v16 or higher)
- npm or yarn
- Firebase Account (for authentication)
- Backend API (for analysis functionality)
-
Clone the repository
git clone https://github.com/your-username/checkly.git cd checkly -
Install dependencies
npm install # or yarn install -
Set up environment variables
cp .env.example .env.local
-
Configure Firebase
- Create a Firebase project
- Enable Authentication
- Add your Firebase config to
.env.local
-
Start the development server
npm run dev # or yarn dev -
Open your browser
http://localhost:5173
Create a .env.local file in the root directory:
# Firebase Configuration
VITE_FIREBASE_API_KEY=your_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_auth_domain
VITE_FIREBASE_PROJECT_ID=your_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_storage_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
VITE_FIREBASE_APP_ID=your_app_id
# Backend API
VITE_API_BASE_URL=http://localhost:8080/api/v1The frontend requires a backend API for website analysis. Make sure your backend is running on the specified port and endpoints.
- Navigate to the homepage
- Enter the website URL you want to analyze
- Click "Analyze" button
- Wait for the analysis to complete
- Review the comprehensive dashboard
- Check scores for Security, Performance, and SEO
- Sign in to access AI-powered recommendations
- Click "Generate AI Recommendations"
- Review personalized suggestions and improvements
- Download detailed analysis reports
- Share results with your team
- Track improvements over time
checkly/
├── public/ # Static assets
├── src/
│ ├── assets/ # Images and static files
│ ├── components/ # React components
│ │ ├── AnalysisDashboard.jsx
│ │ ├── AIRecommendations.jsx
│ │ ├── AuthModal.jsx
│ │ └── ...
│ ├── services/ # API services
│ │ └── websiteAnalysis.js
│ ├── App.jsx # Main application component
│ ├── main.jsx # Application entry point
│ └── index.css # Global styles
├── package.json # Dependencies and scripts
├── vite.config.js # Vite configuration
├── tailwind.config.js # Tailwind CSS configuration
└── README.md # This file
App.jsx- Main application with routing and state managementAnalysisDashboard.jsx- Comprehensive analysis results displayAIRecommendations.jsx- AI-powered recommendations with authenticationwebsiteAnalysis.js- API service for backend communication
We welcome contributions from the community! Here's how you can help:
- Check existing issues to avoid duplicates
- Create a new issue with:
- Clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Browser/device information
- Check existing feature requests
- Create a new issue with:
- Detailed feature description
- Use cases and benefits
- Mockups or examples (if applicable)
- Fork the repository
- Create a feature branch
git checkout -b feature/amazing-feature
- Make your changes
- Follow the existing code style
- Add tests for new functionality
- Update documentation
- Commit your changes
git commit -m 'feat: add amazing feature' - Push to your branch
git push origin feature/amazing-feature
- Create a Pull Request
- Code Style: Follow ESLint and Prettier configurations
- Commits: Use conventional commit messages
- Testing: Add tests for new features
- Documentation: Update README and code comments
We're always looking for new ideas to improve ChecKly! Here are some areas where you can contribute:
- Historical Analysis 📊 - Track website performance over time
- Team Collaboration 👥 - Share analysis with team members
- Custom Alerts 🔔 - Set up performance monitoring alerts
- API Integration 🔌 - Connect with popular CMS platforms
- Mobile App 📱 - Native mobile application
- Dark Mode 🌙 - Toggle between light and dark themes
- Customizable Dashboard 🎛️ - Drag-and-drop dashboard widgets
- Advanced Charts 📈 - Interactive data visualizations
- Accessibility ♿ - Improve accessibility features
- PWA Support 📱 - Progressive Web App capabilities
- Offline Mode 🔌 - Work without internet connection
- Performance Optimization ⚡ - Faster loading and analysis
- Internationalization 🌍 - Multi-language support
- Predictive Analytics 🔮 - Predict future performance issues
- Automated Fixes 🔧 - Suggest code changes automatically
- Competitor Analysis 🏆 - Compare with competitor websites
- Content Optimization ✍️ - AI-powered content suggestions
This project is licensed under the MIT License - see the LICENSE file for details.
Owned by Parthib & Debashis
Made with ❤️ by the ChecKly Team
Empowering developers to build better websites
⭐ Star this repository if you found it helpful!
