🏆 PH Cubers Rankings

A web application by the Philippine Cubers Association (PCA) that provides an easy way to view and track World Cube Association (WCA) competition rankings. This project aims to help the Philippine speedcubing community stay updated with competition results and rankings.

🚀 Features

• View WCA competition rankings
• Filter results by region
• Browse different speedcubing events
• Responsive design for mobile and desktop viewing
• Real-time data updates

🛠️ Tech Stack

• Gatsby.js - React-based static site generator
• React - Frontend library
• Tailwind CSS - Utility-first CSS framework
• FontAwesome - Icons
• World Cube Association API - Competition data

🏃‍♂️ Getting Started

Prerequisites

• Node.js (version 20.x)
• npm (version 10.x)

Installation

1. Clone the repository:

   git clone https://github.com/pca/web-frontend.git
   cd web-frontend
   

2. Install dependencies:

   npm install
   

3. Start the development server:

   npm run develop
   

4. Open your browser and visit http://localhost:8000

The site will automatically reload if you make changes to the code.

🤝 Contributing

We welcome contributions from developers of all skill levels! Here's how you can help:

For Beginners

1. Find an Issue: Look for issues labeled good first issue or beginner-friendly in our GitHub Issues
2. Setup the Project: Follow the installation steps above
3. Make Changes:
   • Work on the issue
   • Test your changes locally
   • Make sure the code follows our formatting rules (run npm run format)
4. Submit a Pull Request:
   • Fork the repository
   • Create a new branch for your feature
   • Commit your changes
   • Push to your fork
   • Open a Pull Request with a clear description

Project Structure

• /src/components/ - React components
  • /homeComponents/ - Components for the home page
  • /rankingComponents/ - Components for the rankings page
  • /uiComponents/ - Reusable UI components
• /src/images/ - Image assets
• /src/pages/ - Page components
• /src/styles/ - Global styles and Tailwind configuration

Development Guidelines

1. Follow the existing code style
2. Write meaningful commit messages
3. Update documentation if needed
4. Test your changes thoroughly
5. Ask for help in the issues if you're stuck!

🧪 Running Tests

npm run test

📝 License

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

🙏 Acknowledgments

• World Cube Association for providing the competition data
• Philippine Cubers Association members and contributors
• The global speedcubing community

📫 Contact

For questions or suggestions, please open an issue in the repository or reach out to the Philippine Cubers Association through our official channels.

Made with ❤️ by the Philippine Cubers Association