Cricket Resource Directory Generator

A powerful, lightweight, and open-source Static Site Generator (SSG) built specifically for creating high-performance cricket resource directories.

This project powers Crickets.site, the ultimate directory for cricket news, live scores, statistics, and IPL/WPL resources.

Features

• Blazing Fast: Generates static HTML for maximum performance.
• SEO Optimized: Built-in JSON-LD Schema, meta tags, and canonical URL handling.
• Themeable: Includes dark/light mode support.
• Data-Driven: Generates pages dynamically from JSON data files.
• Responsive Design: Mobile-friendly layout with sidebar navigation.

Installation

Method 1: Use as a CLI Tool (Recommended for instant use)

You can run the generator directly without installing anything:

npx crickets-site

Method 2: Install from NPM

Install it globally to use it anywhere:

npm install -g crickets-site
crickets-site

Method 3: Clone Source (For Contributors)

To contribute or modify the source code:

git clone https://github.com/crickets-site/crickets.site.git
cd crickets-site
npm install

Usage

Development (Source Mode)

To build the site and serve it locally:

npm run dev

Production Build

To generate the static site in the out/ directory:

npm run build

Deployment

Environment Variables

For production deployment (e.g., Vercel, Netlify, Cloudflare Pages), you can enable Google Tag Manager by setting the following environment variable:

• GTM_ID: Your Google Tag Manager Container ID (e.g., GTM-XXXXXX).

If this variable is not set, the GTM script will not be injected, ensuring privacy and cleaner code for development.

Contributing

We welcome contributions! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.