docs: Add comprehensive GitHub About section and improve repository metadata

bejranonda · claude · bejranonda · commit c9aa8d3452f1 · 2026-02-10T21:02:54.000+01:00
- Create about.md with project description, features, and badges
- Update package.json with comprehensive keywords for discoverability
- Add GitHub Actions workflow for automated deployment
- Create CONTRIBUTING.md guidelines for contributors
- Add repository statistics and live deployment links
- Include technology stack and educational content information

Co-Authored-By: Claude Haiku 4.5 &lt;noreply@anthropic.com&gt;
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,51 @@
+name: Deploy to Cloudflare Pages
+
+on:
+  push:
+    branches: [ master, main ]
+    paths-ignore:
+      - 'node_modules'
+      - '.git'
+      - 'dist'
+  pull_request:
+    branches: [ master, main ]
+  workflow_dispatch:
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      deployments: write
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build project
+        run: npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./dist
+
+      - name: Deploy to Cloudflare Pages
+        uses: cloudflare/pages-action@v3
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: thaisim2026
+          directory: dist
+          productionBranch: master
+          alias: thaisim2026.autobahn.bot
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,99 @@
+# Contributing to Sim-Thailand 2569 🇹🇭
+
+Thank you for your interest in contributing to Sim-Thailand 2569! This document provides guidelines for contributing to the project.
+
+## 🤝 How to Contribute
+
+### Reporting Issues
+If you find a bug or want to request a new feature, please create an issue using the following format:
+
+**Bug Report:**
+- Title: Clear and descriptive
+- Description: Steps to reproduce the bug
+- Expected behavior: What should happen
+- Actual behavior: What actually happens
+- Screenshots (if applicable)
+
+**Feature Request:**
+- Title: Clear and descriptive
+- Description: Detailed explanation of the feature
+- Use case: Why this feature would be helpful
+- Implementation suggestions (if any)
+
+### Pull Requests
+We welcome pull requests! Here's how to contribute:
+
+1. **Fork the repository** - Fork the main repository
+2. **Create a feature branch** - `git checkout -b feature/amazing-feature`
+3. **Make your changes** - Follow the coding standards below
+4. **Test your changes** - Run `npm run build` to ensure it builds successfully
+5. **Commit your changes** - Use conventional commit format
+6. **Push to your fork** - `git push origin feature/amazing-feature`
+7. **Create a Pull Request** - Clear description of changes made
+
+## 📝 Coding Standards
+
+### JavaScript/HTML/CSS
+- Use ES6+ JavaScript features
+- Follow existing code style and formatting
+- Use meaningful variable and function names
+- Add comments for complex logic
+- Ensure responsive design for mobile devices
+
+### Git Commit Messages
+Use conventional commit format:
+```
+feat: add new feature
+fix: resolve bug
+docs: update documentation
+style: format code
+refactor: restructure code
+test: add tests
+chore: maintenance
+```
+
+### Pull Request Template
+```markdown
+## Description
+Brief description of the changes
+
+## Changes Made
+- [ ] Change 1
+- [ ] Change 2
+- [ ] Change 3
+
+## Testing
+- [ ] Tested on Chrome
+- [ ] Tested on Firefox
+- [ ] Tested on Mobile
+
+## Related Issue
+Closes #123
+```
+
+## 📁 Project Structure
+
+```
+ThaiSim2569/
+├── src/
+│   ├── js/           # JavaScript files
+│   └── css/          # CSS styles
+├── Campaign2569/     # Political campaign data
+├── dist/            # Build output
+└── docs/            # Documentation
+```
+
+## 🔧 Development Setup
+
+1. Clone the repository
+2. Install dependencies: `npm install`
+3. Run development server: `npm run dev`
+4. Build for production: `npm run build`
+
+## 📄 License
+
+By contributing to this project, you agree that your contributions will be licensed under the MIT License.
+
+## 🙏 Acknowledgments
+
+Thank you for contributing to Sim-Thailand 2569! Your help makes this educational resource better for everyone.
diff --git a/about.md b/about.md
@@ -0,0 +1,109 @@
+# Sim-Thailand 2569 🇹🇭
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Version](https://img.shields.io/badge/v3.3.0-blue.svg)](https://github.com/bejranonda/ThaiSim2026/releases)
+[![Website](https://img.shields.io/badge/Website-green.svg)](https://thaisim2026.autobahn.bot)
+[![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-gray.svg)](https://thaisim2026.autobahn.bot)
+[![GitHub Actions](https://github.com/bejranonda/ThaiSim2026/actions/workflows/deploy.yml/badge.svg)](https://github.com/bejranonda/ThaiSim2026/actions/workflows/deploy.yml)
+[![Contributors](https://img.shields.io/github/contributors/bejranonda/ThaiSim2026.svg)](https://github.com/bejranonda/ThaiSim2026/graphs/contributors)
+[![Forks](https://img.shields.io/github/forks/bejranonda/ThaiSim2026.svg)](https://github.com/bejranonda/ThaiSim2026/network/members)
+[![Stars](https://img.shields.io/github/stars/bejranonda/ThaiSim2026.svg)](https://github.com/bejranonda/ThaiSim2026/stargazers)
+
+> **Thai Political Simulation Game** - Build your dream nation through real policy choices from 18 political parties across 6 critical phases.
+
+## 🎮 About Sim-Thailand 2569
+
+Sim-Thailand 2569 is an interactive political simulation designed for the 2026 Thai General Election context. It allows users to experience governance by making policy decisions and seeing how they impact the country.
+
+### Key Features
+- **18 Political Parties**: Complete with real policy platforms from the 2569 election cycle
+- **6 Critical Phases**: Cover major policy areas like Economy, Land/Agriculture, Welfare, Anti-Corruption, National Security, and Future/Education
+- **Real-Time Results**: Live dashboard showing voting trends from all users
+- **Party Matching**: Get matched with a political party based on policy alignment
+- **Interactive Voting**: Cast manual votes for your preferred party
+- **Educational Tool**: Learn about the Thai political landscape through simulation
+
+### 📊 Tracking Metrics
+The simulation tracks three key pillars of governance:
+- 📈 **Economy (ศก.)** - Economic and fiscal policy decisions
+- 🤝 **Welfare (สังคม)** - Social welfare and quality of life policies
+- ⚖️ **Democracy (ปชต.)** - Democratic values and governance principles
+
+## 🚀 Technology Stack
+
+- **Frontend**: HTML5, CSS3, JavaScript (ES6+)
+- **UI Framework**: Tailwind CSS
+- **Build Tool**: Vite
+- **Charts**: Chart.js for data visualization
+- **Database**: Firebase Firestore for real-time data
+- **Deployment**: Cloudflare Pages
+
+## 🎯 How It Works
+
+1. **Start Simulation**: Users begin with an introduction to the simulation
+2. **Policy Decisions**: Navigate through 6 phases making critical policy choices
+3. **View Results**: See how policies affect the three tracking metrics
+4. **Party Matching**: Get matched with the most aligned political party
+5. **Vote & Share**: Cast your vote and share results on social media
+
+## 📚 Educational Content
+
+All policies are sourced from the **Nation Election DEBATE** (Updated: 17 January 2569) to ensure accuracy and educational value. Reference materials and debate transcripts are organized in the `/Campaign2569` folder.
+
+## 🔧 Getting Started
+
+### Prerequisites
+- Node.js 18 or higher
+- npm or yarn package manager
+
+### Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/bejranonda/ThaiSim2026.git
+cd ThaiSim2026
+
+# Install dependencies
+npm install
+
+# Run the development server
+npm run dev
+
+# Build for production
+npm run build
+```
+
+### Environment Setup
+
+The app requires Firebase environment variables to be set. Refer to the [Cloudflare Deployment Guide](./CLOUDFLARE_DEPLOYMENT.md) for detailed setup instructions.
+
+## 🌐 Live Deployment
+
+- **Production**: https://thaisim2026.autobahn.bot
+- **GitHub Repository**: https://github.com/bejranonda/ThaiSim2026
+
+## 📈 Statistics
+
+- **40,000+** active participants in the first two weeks
+- **100,000+** unique visits
+- **18** political parties with real policy platforms
+- **6** simulation phases covering critical policy areas
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Developed by [Thalay.eu](https://thalay.eu/)
+- Political data sourced from Nation Election DEBATE 2569
+- Built with [Vite](https://vitejs.dev/) and [Tailwind CSS](https://tailwindcss.com/)
+- Deployed on [Cloudflare Pages](https://pages.cloudflare.com/)
+
+---
+
+**Note**: This simulation is for educational purposes only and provides an interactive way to understand Thai political policy platforms.
diff --git a/package.json b/package.json
@@ -12,10 +12,20 @@
   },
   "keywords": [
     "thailand",
-    "politics",
-    "simulation",
-    "game",
-    "election"
+    "thai-election",
+    "political-simulation",
+    "educational-game",
+    "policy-simulation",
+    "democracy",
+    "thai-politics",
+    "interactive-game",
+    "civic-engagement",
+    "election-2026",
+    "thai-government",
+    "policy-matching",
+    "voting-simulation",
+    "educational-tool",
+    "civic-education"
   ],
   "author": "",
   "license": "MIT",
