Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/delucis/astro-badge

Badges for Astro projects
https://github.com/delucis/astro-badge

astro badge

Last synced: 6 days ago
JSON representation

Badges for Astro projects

Awesome Lists containing this project

README

        

# Astro Badges

[![Built with Astro](./public/v2/built-with-astro/small.svg)](https://astro.build)

This project aims to celebrate the contributions of the [Astro](https://astro.build/) community.

Get badges to show off on your sites and READMEs!
👉 **** 👈

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command | Action |
| :------------- | :------------------------------------------- |
| `pnpm i` | Installs dependencies |
| `pnpm start` | Starts local dev server at `localhost:4321` |
| `pnpm build` | Build your production site to `./dist/` |
| `pnpm preview` | Preview your build locally, before deploying |

### Data collection

This project uses the GitHub REST API to gather public data about contributions to [the `withastro` org](https://github.com/withastro/). Data collection is run once per day in a GitHub action and automatically committed to this repository.

You can run `pnpm collect-stats` to run data collection locally (for example to test changes to the script), but should first ensure a `GITHUB_TOKEN` [environment variable](https://docs.astro.build/en/guides/environment-variables/) is set up, containing a GitHub personal access token. Create a `.env` file in the repo root and add your token there for it to be detected automatically for local runs:

```dotenv
GITHUB_TOKEN=github_pat_......
```