badges / shields

Concise, consistent, and legible badges in SVG and raster format
https://shields.io
Creative Commons Zero v1.0 Universal
23.91k stars 5.51k forks source link

Badge Request : ClassicPress #6814

Open smileBeda opened 3 years ago

smileBeda commented 3 years ago

:clipboard: Description

This badge(s) are intended for ClassicPress, similar to the existing WordPress Badges. The badges should show /classicpress/plugin/required-php/:slug /classicpress/theme/required-php/:slug /classicpress/plugin/cp-version/:slug /classicpress/theme/cp-version/:slug /classicpress/plugin/tested/:slug

Example: https://img.shields.io/badge/classicpress-1.0.0-%23057f99 Since CPs brand colors are: Primary Aqua – #057f99 Deep Violet – #361946 Mid Violet – #89288f

We would use #057f99 for the main badges, and green for the /cp/plugin/tested/:slug one (like so https://img.shields.io/badge/classicpress-v1.0.0%20tested-brightgreen)

The brand guidelines are here https://www.classicpress.net/brand-guidelines/ The latests CP Version is here https://github.com/ClassicPress/ClassicPress

While the community is still small, ClassicPress is not going anywhere but forwards - thus the number of users using this will grow over time.

chris48s commented 3 years ago

To enable someone to work on this, can you link to ClassicPress API docs and an example of a public ClassicPress instance where we can make some API calls.

When it comes to colours, shields.io uses colours semantically (to convey information) rather than for branding purposes i.e:

smileBeda commented 3 years ago

Hi there and sorry for the delay. We're finalising the API, I didn't know we would need a functional API at the moment I asked for the shield, but of course, it makes perfect sense.

I'm right now talking to the lead dev of said API to get information about this so I can pass it here.

smileBeda commented 3 years ago

The API is accessible at https://directory.classicpress.net/api/plugins/

Example query for a single https://directory.classicpress.net/api/plugins/{plugin-slug} Returned data:

{
    "data": {
        "name": "Raynor Inc",
        "description": "Ex deleniti veritatis nulla blanditiis sed.",
        "developer": {
            "name": "Roberto Tremblay",
            "slug": "qui-repellendus-eos-explicabo",
            "web_url": "http://localhost/plugins/qui-repellendus-eos-explicabo",
            "username": "jaskolski.anastasia",
            "website": "https://ziemann.com/nihil-tempore-repellendus-aut-molestiae-veritatis-architecto-dolore.html",
            "published_at": "2021-05-24 17:24:02"
        },
        "slug": "harum-nemo-nisi-tenetur-qui-sunt-aut",
        "web_url": "http://localhost/plugins/harum-nemo-nisi-tenetur-qui-sunt-aut",
        "minimum_wp_version": "4",
        "minimum_cp_version": "1",
        "current_version": "12",
        "latest_cp_compatible_version": "1",
        "git_provider": null,
        "repo_url": "http://www.steuber.biz/eligendi-autem-tempora-eos-eos",
        "download_link": "https://lorempixel.com/640/480/?53840",
        "comment": "Sit consequatur perspiciatis placeat ad nisi in et nihil.",
        "type": {
            "key": "CP",
            "value": 0,
            "description": "Developed for ClassicPress"
        },
        "published_at": "2021-05-24 17:24:02"
    }
}

The full list of all plugins can be accessed at https://directory.classicpress.net/api/plugins/ Navigation parameters can be seen at the bottom of said page.

The documentation of said API is here.

Let me know if you need more details.