♟️ brisbanesocialchess.github.io

Welcome to the source code repository for the Brisbane Social Chess Inc website.

---

ℹ️ About the Site Generator

This site is built using Eleventy (11ty), a modern and flexible static site generator for JavaScript projects. Eleventy takes your content and templates and generates a fast, static site. You do not need to know advanced JavaScript to get started - just follow the steps below!

• Live site: https://www.brisbanesocialchess.org.au/
• GitHub Pages: Current development site https://brisbanesocialchess.github.io/
• Cloudflare Pages: Pull request deploy previews https://brisbanesocialchess.pages.dev/
• Cloudflare Workers: Playground https://cfsite.brisbanesocialchess.workers.dev/
• Read the Docs: Skeleton book and documentation site https://brisbanesocialchess.readthedocs.io/en/latest/
• CONTRIBUTING Guide

---

• 📃 About Brisbane Social Chess Inc
• 🚀 Quick Start
• 🛠️ Technology Stack
  • ⚡ Cloudflare Workers Development
    • ▶️ Start Development Server
    • 🏃 Run Tests
    • 📊 Run Coverage Reports
  • 🏗️ Getting Started / Building the Site
  • 🐳 Build the Docker image for running pre-commit easily
  • 📚 Build the Documentation
• 👥 Contributors

---

📃 About Brisbane Social Chess Inc

Brisbane Social Chess Inc is a not-for-profit organization in Queensland that promotes the game of chess through social gatherings and community engagement. We organize regular meetups where people can play chess in a relaxed and friendly environment. We are registered in Queensland and have a dedicated team of organizers.

---

🚀 Quick Start

For detailed development setup instructions, see DEVELOPER_HELP.md.

Experiment with Lerna and bootup a local developer playground from the repository root with: npx lerna run dev.

🛠️ Technology Stack

• Cloudflare is a connectivity cloud that provides a range of services to improve the security, performance, and reliability of sites and applications. It acts as a Content Delivery Network (CDN), reverse proxy, and provides cybersecurity solutions. In essence, Cloudflare helps businesses connect, protect, and build their online presence.
• Cloudflare D1 is a serverless relational database in seconds with D1. With a familiar SQL query language, point-in-time recovery, and cost-effective pricing, you are empowered to build the next big thing.
• Cloudflare Workers is a serverless platform for building, deploying, and scaling apps across Cloudflare's global network ↗ with a single command - no infrastructure to manage, no complex configuration.
• Cloudflare Wrangler is a command-line tool designed to help developers build and manage applications on the Cloudflare developer platform, particularly for Cloudflare Workers. It streamlines the process of deploying, testing, and configuring Workers, as well as interacting with other Cloudflare developer products.
• Docker is an open-source platform designed to simplify the process of building, deploying, and running applications using containerization. It packages an application and all its dependencies (libraries, system tools, code, runtime) into a standardized unit called a "container."
• Eleventy (also known as 11ty) is a static site generator. It's a tool that transforms content (like Markdown, HTML, or JavaScript) and templates into static HTML files, making it faster and easier to build sites. Unlike dynamic site builders, 11ty generates all the site's content upfront, which leads to better performance and simpler deployments.
• GitHub Pages is a static site hosting service offered by GitHub, enabling users to host sites directly from their GitHub repositories. It is designed for publishing static content, meaning it primarily handles HTML, CSS, and JavaScript files, and does not support server-side languages like PHP or Python for dynamic content generation.
• Lerna is a tool for optimizing the workflow around managing multi-package repositories (monorepos).

• Makefile is a text file that contains a set of instructions used by the make utility to automate the process of building and managing software projects. It defines dependencies between files and specifies the commands required to update outdated files or generate new ones.

• Nunjucks is a powerful and flexible templating engine for JavaScript, heavily inspired by Jinja2 (a popular templating engine for Python). It allows developers to create dynamic HTML, XML, or other text-based content by embedding logic, variables, and control structures directly within templates.
• Read the Docs is a Continuous Documentation Deployment platform designed to simplify the process of building, versioning, and hosting technical documentation, particularly for software projects. It operates on the principle of "docs as code," integrating with version control systems like Git (GitHub, GitLab, Bitbucket) to automatically build and update documentation whenever changes are committed to the repository.
• reStructuredText (RST) is a lightweight markup language designed for creating easy-to-read and easy-to-write plaintext documents that can be automatically converted to various output formats, such as HTML, LaTeX (and thus PDF), and more. It is a key component of the Docutils project and is widely used in the Python community for writing technical documentation, including Python's official documentation and documentation for many Python libraries.
• Sphinx is a powerful and widely-used documentation generator written in Python. It is particularly popular within the Python community and is considered the de facto standard for documenting Python projects.
• Tailwind CSS is a utility-first CSS framework designed for rapidly building custom user interfaces directly within HTML. Unlike traditional CSS frameworks that provide pre-built components (like buttons or navigation bars), Tailwind offers a comprehensive set of low-level utility classes.
• Vitest is a blazing-fast, next-generation testing framework designed for modern JavaScript and TypeScript projects, built on top of Vite. It's known for its speed and developer experience, offering instant feedback and seamless integration with Vite's features like hot module replacement (HMR). Vitest is inspired by Jest and aims to provide a familiar yet enhanced testing experience.

⚡ Cloudflare Workers Development

To work with the Cloudflare Workers site in the packages/cfsite directory:

▶️ Start Development Server

cd packages/cfsite
npx wrangler dev

🏃 Run Tests

cd packages/cfsite
npm run test

📊 Run Coverage Reports

To generate a code coverage report:

• Frontend (root): generates test coverage for the frontend code

npm run coverage

• Backend (Cloudflare Workers in packages/cfsite): generates test coverage for the backend code

cd packages/cfsite
npm run coverage

Read below for instructions about the current static development site hosted on GitHub Pages.

---

🏗️ Getting Started / Building the Site

First, from the project's root directory, install the necessary dependencies:

npm ci

To start a local development server with live reload, run:

npm run start

---

🐳 Build the Docker image for running pre-commit easily

• Standard build:

docker build -t my-go-precommit .

• Build without cache:

docker build --no-cache -t my-go-precommit .

• On a Mac with an M2 chip:

docker build --platform=linux/amd64 -t my-go-precommit .

And then:

• Standard build:

docker run --rm -v "$PWD":/app -w /app my-go-precommit

Or if you want to run and keep the container and go into Bash:

docker run -it -v "$PWD":/app -w /app my-go-precommit bash

• On a Mac with an M2 chip:

docker run --platform=linux/amd64 --rm -v "$PWD":/app -w /app my-go-precommit

---

📚 Build the Documentation

Run the following commands from the repository root to create the Sphinx documentation with Make:

cd doc
make html

The generated HTML site will be in the doc/build/html folder. You can open the HTML files with your web browser.

---

👥 Contributors

---

© 2025 Brisbane Social Chess Inc