A static dashboard showcasing WronAI's open source projects with automatic repository analysis and deployment to GitHub Pages.
- Automatic repository analysis via GitHub Actions
- Package manager detection (pip, npm, yarn, poetry)
- PyPI package verification
- Docker support detection
- GitHub Actions workflow detection
- Responsive design with dark mode support
- Automated deployment to GitHub Pages
- Concurrent deployment protection
- Branch-specific deployments
The main build automation tool. Provides convenient commands for development and deployment.
Available Commands:
make help # Show all available commands
make install # Install all dependencies
make dev # Start development server (http://localhost:3000)
make build # Build for production
make preview # Preview production build
make clean # Clean build artifacts
make update-repos # Update repository data
make setup-dev # Set up development tools
make test-gh-actions # Test GitHub Actions locally
make setup-test-env # Set up test environment
A utility script to combine README.md files from subdirectories into a single SUM.md
file.
Features:
- Combines multiple README.md files into one
- Respects
.gitignore
rules - Configurable search depth
- Handles non-git directories
- Shows progress during processing
Usage:
# Default (2 levels deep)
./combine_readmes.sh
# Specify custom depth (e.g., 3 levels)
./combine_readmes.sh 3
The main data file containing repository information. This file is automatically generated and should not be edited manually.
Location:
repos.json
- Main repository datasrc/repos.json
- Copy used by the development server
Python script that analyzes repositories and updates repos.json
with the latest information.
Usage:
python update_repos.py
Contains the source code for the dashboard.
Key files:
src/index.html
- Main HTML filesrc/css/
- Stylesheetssrc/js/
- JavaScript filessrc/repos.json
- Copy of repository data for development
GitHub Actions workflow files:
analyze.yml
- Runs repository analysisdeploy.yml
- Handles deployment to GitHub Pagesstatic-deploy.yml
- Alternative deployment configuration
- Node.js 20+ (LTS recommended)
- npm
- Python 3.10+ (for repository analysis)
- Docker (for local GitHub Actions testing)
-
Clone the repository:
git clone https://github.com/wronai/www.git cd www
-
Install dependencies:
make install
-
Start development server:
make dev
This starts a local server at http://localhost:3000
Run make help
to see all available commands:
make help Show this help
make install Install dependencies
make dev Start development server
make build Build for production
make preview Preview production build
make clean Clean build artifacts
make update-repos Update repository data
make setup-dev Set up development tools
make test-gh-actions Test GitHub Actions locally
make setup-test-env Set up test environment
./combine_readmes.sh [depth] Combine all README.md files (default depth: 2)
The combine_readmes.sh
script combines all README.md files in subdirectories into a single SUM.md file. It respects .gitignore
files and allows you to control the search depth.
- Combines README.md files from subdirectories into a single file
- Respects
.gitignore
rules to skip ignored directories - Configurable search depth (default: 2 levels deep)
- Handles non-git directories gracefully
- Shows progress during processing
# Default (2 levels deep)
./combine_readmes.sh
# Specify custom depth (e.g., 3 levels)
./combine_readmes.sh 3
The system automatically analyzes repositories to extract:
- Package information (name, version)
- Dependencies
- Docker support
- CI/CD configuration
- Last update time
- Language detection
To manually update repository data:
make update-repos
www/
├── src/ # Source files
│ ├── css/ # Stylesheets
│ ├── js/ # JavaScript files
│ └── index.html # Main HTML file
├── .github/workflows/ # GitHub Actions workflows
├── repo-analyzer/ # Repository analysis tools
├── scripts/ # Utility scripts
└── update_repos.py # Main repository update script
-
Analyze Repositories (
.github/workflows/analyze.yml
)- Runs daily at 4 AM UTC or on push to
repo-analyzer/**
- Updates
repos.json
with repository information
- Runs daily at 4 AM UTC or on push to
-
Deploy to GitHub Pages (
.github/workflows/deploy.yml
)- Triggers on push to
main
branch - Builds and deploys the production site
- Triggers on push to
-
Static Site Deployment (
.github/workflows/static-deploy.yml
)- Alternative deployment with SPA routing support
- Fork the repository
- Create a feature branch
- Commit your changes
- Push to the branch
- Create a Pull Request
This project is licensed under the terms of the MIT license. See LICENSE for more details.
The site is automatically deployed to GitHub Pages through GitHub Actions. The deployment process:
-
Analysis Workflow:
- Runs daily or on push to
repo-analyzer/**
- Updates repository metadata
- Commits changes to
repos.json
- Runs daily or on push to
-
Deployment Workflow:
- Triggers on push to
main
or after analysis - Installs dependencies
- Builds the production site
- Deploys to GitHub Pages
- Triggers on push to
- Make your changes
- Commit and push to
main
- The deployment will start automatically
-
Build fails
- Run
npm install
to ensure all dependencies are installed - Check for errors in the GitHub Actions logs
- Run
-
Repository data not updating
- Run
make update-repos
manually - Check the
analyze
workflow logs
- Run
-
Deployment fails
- Verify all required files exist
- Check for syntax errors in the workflow files
- Ensure GitHub Pages is properly configured in the repository settings
Apache 2.0
Apache