Skip to content

Commit

Permalink
docs: add self-hosting instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobLinCool committed Mar 3, 2024
1 parent 30b05f0 commit 913bd70
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,16 @@ LeetCode and LeetCode CN are both supported.

It also has a [NPM package](https://www.npmjs.com/package/leetcode-card) and a [highly extensible system](./src/core/index.ts), so you can easily customize it to your needs.

CLI tool will be created if I have time.
Want to contribute? Feel free to open a pull request!

## Self-hosting

You can also self-host this service using the [`jacoblincool/leetcode-stats-card`](https://hub.docker.com/r/jacoblincool/leetcode-stats-card) Docker image.

To build the image by yourself, use `pnpm build:image` script.

See [docker-compose.yml](./docker-compose.yml) for an example.

## Usage

Simply copy the code below, paste it into your `README.md`, and change the path to your leetcode username (case-insensitive).
Expand Down

0 comments on commit 913bd70

Please sign in to comment.