https://github.com/caseywebb/dcp-badger

Fancy README Grids for DailyCodingProblem Repos
https://github.com/caseywebb/dcp-badger

daily-coding-problem dailycodingproblem dailyprogrammer dcp

Last synced: 13 days ago
JSON representation

Fancy README Grids for DailyCodingProblem Repos

• Host: GitHub
• URL: https://github.com/caseywebb/dcp-badger
• Owner: caseyWebb
• License: wtfpl
• Created: 2018-11-27T20:04:28.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T04:11:01.000Z (almost 2 years ago)
• Last Synced: 2024-10-18T07:13:34.451Z (3 months ago)
• Topics: daily-coding-problem, dailycodingproblem, dailyprogrammer, dcp
• Language: TypeScript
• Size: 991 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# dcp-badger

> Generate fancy-shmancy completion grids for your [DailyCodingProblem][] repository

Shamelessly copied from the GitHub profile activity grid.

## Example

![caseyWebb's DailyCodingProblem completion][my-grid]

## Usage

```markdown

![](https://apps.caseywebb.xyz/dcp-badger?repo=caseyWebb/dcp)

```

By default, files are expected to exist in the repo under `///.ext`.

Custom file structures are supported via the [`regex`](#regex) param.

## Configuration

All params are passed via querystring

### repo [required]

Specify the (GitHub) repository to generate a grid for. Currently, the GitHub API is used, and not a git clone, so only public GitHub repos are supported.

example: `repo=caseyWebb/dcp`

### ref

The git ref (branch, tag, etc.) to use.

Defaults to `master`

### regex

A regular expression with `year`, `month`, and `day` [named capture groups](https://github.com/tc39/proposal-regexp-named-groups). For matching source files to days.

For example, if instead of the default `//.ext`, if you wanted to use a flat file structure and name your files `--.ext`, you could set the `regex` parameter to `(?\\d{4})-(?\\d+)-(?\\d+)\\.ext`. Flex those regex muscles.

Defaults to `(?\\d{4})/(?\\d+)/(?\\d+)\\.` (see `ext` param below)

### ext

Solve the problems in multiple languages, and want to generate separate grids? Me too!

If `` exists in the regex string (which it does by default), the value of the `ext` param will be substituted.

Defaults to `.+` (any)

### labelColor

Color to use for the grid labels

Defaults to `#767676`

### completeColor

Color to use for completed days

Defaults to `#7bc96f`

### incompleteColor

Color to use for incomplete days

Defaults to `#ebedf0`

### futureColor

Color to use for days in the future

Defaults to `rgba(0,0,0,0)`

[DailyCodingProblem]: https://dailycodingproblem.com

[my-grid]: https://apps.caseywebb.xyz/dcp-badger?repo=caseyWebb/dcp