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

https://github.com/ilyhalight/stats-cards

🦀 Blazing fast stats cards for everything
https://github.com/ilyhalight/stats-cards

cards fast readme stats wakatime

Last synced: 7 months ago
JSON representation

🦀 Blazing fast stats cards for everything

Awesome Lists containing this project

README

          

# stats-cards

🦀 Blazing fast stats cards for everything

## Available cards

Current list of available cards:

- Wakatime languages (compact with progress)

demo

- Github languages (compact with progress)

demo

- Github Activity Graph

demo

Support disabling title with param `with_title`:

- `true` (default)
- `false`

Support select period with param `period`:

- `3_months` (default)
- `6_months`
- `year`

\* Required GITHUB_TOKEN in `.env`

List of planned cards:

- [WIP] [Github Streak](https://github.com/DenverCoder1/github-readme-streak-stats)
- [WIP] [Wakatime Streak](https://github.com/DenverCoder1/github-readme-streak-stats)
- [WIP] [Github stats](https://github.com/anuraghazra/github-readme-stats)
- [WIP] [GitHub Extra Pins](https://github.com/anuraghazra/github-readme-stats)
- [WIP] [GitHub Gist Pins](https://github.com/anuraghazra/github-readme-stats)

\* links contain design examples

## Themes

Available themes:

- [Catpuccin Macchiato](https://github.com/catppuccin/catppuccin) (default)

## How to run

To run your own instance:

### With Docker

1. Install [Docker](https://www.docker.com/)
2. Build the image

```bash
docker build -t "stats-cards" .
```

3. Run container

```bash
docker run -p 7674:7674 stats-cards
```

### Manually

1. Install [Rust 1.75+](https://www.rust-lang.org/learn/get-started)

2. (Optional) Run for developing:

2.1. Install cargo watch:

```bash
cargo install cargo-watch
```

2.2. Run live server:

```bash
cargo watch -x run
```

3. Run for Production:

3.1. Build:

```bash
cargo build --release
```

3.2. Run a stats-cards file:

```bash
./target/release/stats-cards
```

Written with ❤️ & 🦀