README.md

🏏 Crickly

Crickly is a simple app to store cricket match details.

📝 Note: Development is still in progress and not in a stable state.

Detailed documentation is in the docs directory. (Not produced yet. So instead heres a unicorn... 🦄)

🛫 Quick start

1. Install pip install crickly

2. Add crickly to your INSTALLED_APPS setting like this

    INSTALLED_APPS = [
        ...
        'crickly.core',
    ]

3. Include the URLconf in your project urls.py like this

    path(r'^matches/', include('crickly.core.urls.matches')),
    path(r'^stats/', include('crickly.core.urls.stats')),
    path(r'^api/', include('crickly.core.urls.api')),

4. Run python manage.py migrate to create the crickly models.

5. Run python manage.py collectstatic to get static files.

6. Add this to your base template

    <script src="{% static "crickly/scripts.js"%}"></script>
    <script src="https://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>

7. Start the development server and visit http://127.0.0.1:8000/admin/ to create a match (you'll need the Admin app enabled).

8. Visit http://127.0.0.1:8000/matches/ to view match details. Visit http://127.0.0.1:8000/stats/ to view statistics.

🔧 Extensions

There are several extensions to make this app more usable, they are:

• Crickly-playcricket: This extension links the core app to the ECB Play Cricket system. It is helpful for clubs who play in leagues that require the results to be added to playcricket.
• Crickly-matchreports: ⚙️ Under Development. This adds a match report section to the website.
• Crickly-fantasyleague: ⚙️ Under Development. This adds a fantasy league section to the website. A good fundraiser for cricket clubs.
• Crickly-PCSP-BBB: ⚙️ Under Development. This adds support for a ball by ball feed from Play Cricket Scorer Pro. Requires crickly-playcricket