Skip to content

Pythoript/oceanside-chess-website

Repository files navigation

Oceanside Chess Club Website

Welcome to the Oceanside Chess Club website repository! This project powers the official website of the Oceanside Chess Club, a non-profit society based in Qualicum Beach dedicated to bringing chess to Vancouver Island.

Table of Contents

About the Project

The Oceanside Chess Club's website serves as an informational hub for members and visitors, offering event details, club rules, a chess database, a chess clock, and more.

Features

  • Event Listings: Upcoming tournaments and club meetings.
  • Resources: Chess archive, game database, chess clock, and useful links.
  • Club Information: Club rules, volunteering opportunities, and donation options.
  • News Section: Latest updates and newsletters.
  • Contact Information: Location, email, and meeting hours.
  • SEO Optimization: Meta tags for search engines and social media sharing.
  • Mobile-Friendly Navigation: Responsive design with a hamburger menu.

Installation

Prerequisites

  • A web server (e.g., Apache, Nginx) or a local development server.
  • NodeJS v20.x and npm installed
  • A modern web browser.

Steps

  1. Clone the repository:
     git clone https://github.com/Pythoript/oceanside-chess-club.git
  2. Navigate to the project directory:
     cd oceanside-chess-club
  3. Install dependencies using npm
     npm install
  4. Run the development environment
     npm run dev
  5. Compile the project
    npm run build

The website will be compiled with all bundled resources to the public directory. The latest releases of the site will be made available in Releases section.

Contributing

We welcome contributions! To contribute:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature/new-feature
  3. Make your changes and commit them:
    git commit -m "Add new feature"
  4. Push the branch:
    git push origin feature/new-feature
  5. Submit a pull request.

License

This project is licensed under the GPL-3.0 license .

Contact