Skip to content

airbr/wsg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

WSG-o-matic

A lightweight interactive website for exploring the Web Sustainability Guidelines (WSGs). This project helps users discover and learn about sustainability guidelines for the web.

Features

  • Random Guideline Generator: Instantly view a random WSG guideline.
  • Topic-Based Browsing: Filter and explore guidelines by topic.
  • Interactive UI: Responsive, accessible design with dynamic content.
  • Sustainable Tooling And Reporting (STAR): View related STAR tests for each guideline.
  • Client-side Only: No backend required; all data is loaded via JSON.

Getting Started

  1. Clone this repository:

    git clone https://github.com/airbr/wsg-o-matic.git
    cd wsg-o-matic
  2. Install dependencies:
    No dependencies required. All code is static HTML, CSS, and JS.

  3. Run locally:
    Open index.html in your browser, or use a local server:

    # Python 3.x
    python3 -m http.server
    # Then visit http://localhost:8000

Project Structure

/
β”œβ”€β”€ index.html
β”œβ”€β”€ css/
β”‚   └── styles.css
β”œβ”€β”€ js/
β”‚   └── app.js
β”œβ”€β”€ js/guidelines.json
β”œβ”€β”€ js/star.json
└── ...

Customization

  • Style changes:
    Modify css/styles.css for custom themes or layouts.
  • JS logic:
    Update js/app.js for new features or UI changes.

Credits

License

MIT License. See LICENSE for details.


This project is for educational and demonstration purposes. All guideline content credit to the W3C and contributors.

About

Get a Web Sustainability Guideline! πŸ“¦

Topics

Resources

License

Stars

Watchers

Forks