@cricket-australia/play-cricket-react-ui

Play Cricket React Components

This is a react UI/components library intended for the Play Cricket site.

All of the documentation for this codebase has been moved to this repository's wiki page. All of the pages are linked below:

Documentation

🚀 Setup

• Usage in Sitecore - Explains how this repository works, and how to use this repository in Sitecore to get components rendering. Includes an API reference for this codebase.

  • API Reference

• Local Setup For Developers - Outlines how to get this repo up and running, as well as getting a local instance of the Play Cricket site up for integration purposes.

🛠 Development Guide

• Code Style - Briefly explains general code style and best practices used in this codebase.

• General Development Process - Very short, high level guide on how we develop components and utils from start to finish.

• Styling - How we style components, and best practices

• InteractSport API Usage - How we use the InteractSport API to get the data we need (important!).

• State Management - How this library manages state data (important!).

• Opportunities For Improvement - Work we could do to improve this repo.