Thanks to visit codestin.com
Credit goes to github.com

Skip to content

iyanski/betterlocalgov

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

24 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ›οΈ Local Government Website Starter Kit

A modern, multilingual, and accessible website template designed specifically for local government units (LGUs) in the Philippines. Built with React, TypeScript, and Tailwind CSS.

✨ Features

  • 🌐 Multilingual Support: English, Filipino, Cebuano, and other Philippine languages
  • πŸ“± Responsive Design: Mobile-first approach with modern UI/UX
  • β™Ώ Accessibility: WCAG 2.1 compliant design
  • πŸ“ Content Management: YAML-based content system for easy updates
  • 🎨 Customizable: Easy theming and branding customization
  • ⚑ Fast Performance: Built with Vite for optimal loading speeds
  • πŸ” SEO Optimized: Built-in SEO with react-helmet, meta tags, and Open Graph support

πŸš€ Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Git

Installation

  1. Clone the repository

    git clone https://github.com/iyanski/betterlocalgov.git
    cd betterlocalgov
  2. Install dependencies

    npm install
    # or
    yarn install
  3. Run the setup script

    npm run setup

    This will guide you through configuring your government's information.

  4. Start development server

    npm run dev
    # or
    yarn dev
  5. Open your browser Navigate to http://localhost:5173

πŸ“š Documentation

🎯 Perfect For

  • Local Government Units (Cities, Municipalities, Provinces)
  • Government IT Departments looking for modern web solutions
  • Web Development Agencies serving government clients
  • Civic Technology Organizations building government tools
  • Government Officials wanting professional online presence

⚑ Quick Setup (3-5 hours to live website)

  1. Clone & Install (5 minutes)

    git clone https://github.com/your-org/local-government-starter-kit.git
    cd local-government-starter-kit
    npm install
  2. Configure Your Government (15 minutes)

    npm run setup
    # Interactive setup guides you through configuration
  3. Customize Content (2-4 hours)

    • Edit service information in content/
    • Add your government's services and programs
    • Update contact information and branding
  4. Deploy to Production (15 minutes)

    • Connect to Vercel for free hosting
    • Set up custom domain (optional)
    • Your website is live!

🌟 What Makes This Different

Built for Philippine LGUs

  • Multilingual: English, Filipino, Cebuano, and other local languages
  • Local Context: Designed for Philippine government structure
  • Cultural Sensitivity: Respects local customs and practices
  • Accessibility: WCAG 2.1 compliant for all citizens

Non-Technical Friendly

  • YAML Content Management: Easy content updates without coding
  • Visual Setup: Interactive configuration process
  • Clear Documentation: Step-by-step guides for everything
  • Template System: Pre-built content templates

Modern & Professional

  • Mobile-First: Works perfectly on all devices
  • Fast Loading: Optimized for performance
  • SEO Ready: Built-in search engine optimization
  • Secure: Modern security best practices

πŸ› οΈ Development

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build
  • npm run lint - Run ESLint
  • npm run lint:fix - Fix ESLint issues
  • npm run format - Format code with Prettier
  • npm run setup - Run setup script for new installations
  • npm run convert-yaml - Convert YAML to JSON
  • npm run dev:yaml - Convert YAML and start dev server

Project Structure

src/
β”œβ”€β”€ components/          # Reusable UI components
β”‚   β”œβ”€β”€ home/           # Home page components
β”‚   β”œβ”€β”€ layout/         # Layout components (Navbar, Footer)
β”‚   β”œβ”€β”€ sections/       # Page sections
β”‚   └── ui/             # Basic UI components
β”œβ”€β”€ data/               # Content and configuration
β”‚   β”œβ”€β”€ content/        # Markdown content files
β”‚   └── *.yaml          # Configuration files
β”œβ”€β”€ hooks/              # Custom React hooks
β”œβ”€β”€ i18n/               # Internationalization
β”œβ”€β”€ lib/                # Utility functions
β”œβ”€β”€ pages/              # Page components
└── types/              # TypeScript type definitions

🀝 Contributing

We welcome contributions from everyone! Whether you're a developer, government official, or community member, there are many ways to help improve this project.

🌟 For Non-Technical Contributors

No coding experience required! You can contribute valuable content and improvements using GitHub's web interface.

Quick Start for Non-Technical Users

  1. Create a GitHub account (free at github.com)
  2. Navigate to the repository in your web browser
  3. Use our detailed guide: CONTENT-MANAGEMENT.md - Complete step-by-step instructions for editing content without any technical knowledge

What You Can Contribute

  • πŸ“ Content Updates: Fix outdated information, add new services, improve descriptions
  • 🌐 Translations: Help translate content to Filipino, Cebuano, or other local languages
  • πŸ“‹ Service Information: Add details about government services, requirements, and processes
  • πŸ” Content Review: Check for accuracy, clarity, and completeness
  • πŸ’‘ Suggestions: Propose new features or improvements

How to Contribute (No Git Required)

  1. Find content to edit:

    • Go to content/services/ in the repository
    • Choose a category (health, education, business, etc.)
    • Click on any .md file to edit
  2. Make your changes:

    • Click the pencil icon (✏️) to edit
    • Update the content using simple text formatting
    • Add new information, fix errors, or improve clarity
  3. Save your changes:

    • Write a brief description of what you changed
    • Click "Commit changes"
    • Your changes will be reviewed and merged

Content Types You Can Edit

  • Service Descriptions: How to apply for permits, scholarships, health services
  • Requirements: Documents needed, eligibility criteria, deadlines
  • Contact Information: Office locations, phone numbers, hours
  • Process Steps: Step-by-step instructions for government services
  • Translations: Help make content available in local languages

πŸ‘¨β€πŸ’» For Technical Contributors

Content Contributors (Basic Technical)

  1. Fork the repository
  2. Create a content branch: git checkout -b content/update-health-services
  3. Edit content files in content/
  4. Test your changes: npm run dev
  5. Submit a pull request

Developers

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/new-component
  3. Make your changes
  4. Run tests: npm run lint && npm run build
  5. Submit a pull request

πŸ“‹ Contribution Guidelines

Content Guidelines

  • Accuracy First: Ensure all information is current and correct
  • Clear Language: Write for the general public, avoid jargon
  • Complete Information: Include all necessary details (requirements, steps, contacts)
  • Local Context: Consider the specific needs of your community
  • Accessibility: Use clear headings, simple language, and logical structure

Technical Guidelines

  • Follow existing code style and patterns
  • Test your changes thoroughly
  • Update documentation when needed
  • Ensure mobile responsiveness
  • Maintain accessibility standards

🎯 Priority Areas for Contribution

  1. Content Accuracy: Update outdated information, fix errors
  2. Localization: Translate content to Filipino, Cebuano, and other Philippine languages
  3. Service Coverage: Add missing government services and programs
  4. User Experience: Improve clarity and ease of use
  5. Accessibility: Ensure content is accessible to all citizens

πŸ†˜ Need Help?

  • For Content Questions: Check CONTENT-MANAGEMENT.md
  • For Technical Issues: Open an issue on GitHub
  • For General Questions: Contact the project maintainers

πŸ† Recognition

All contributors are recognized in our project documentation. Your contributions help make government services more accessible to all citizens!

πŸ“„ License

This project is licensed under the Creative Commons Zero (CC0) License - see the LICENSE file for details.

CC0 License Benefits:

  • Public Domain: No restrictions on use, modification, or distribution
  • Government Friendly: Perfect for public sector projects
  • Maximum Reusability: Anyone can use, modify, and distribute freely
  • No Attribution Required: Though attribution is appreciated

πŸ™ Acknowledgments


Made with ❀️ for Philippine Local Government Units

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •