https://github.com/pingcap/ossinsight-lite

🚧[WIP] Yet another customizable free GitHub stats dashboard based on TiDB Serverless: https://ossinsight-lite.vercel.app, hand-drawn style.
https://github.com/pingcap/ossinsight-lite

Last synced: about 1 month ago
JSON representation

🚧[WIP] Yet another customizable free GitHub stats dashboard based on TiDB Serverless: https://ossinsight-lite.vercel.app, hand-drawn style.

• Host: GitHub
• URL: https://github.com/pingcap/ossinsight-lite
• Owner: pingcap
• License: apache-2.0
• Created: 2023-04-25T06:29:35.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-13T01:21:59.000Z (10 months ago)
• Last Synced: 2024-10-31T23:31:01.432Z (about 1 month ago)
• Language: TypeScript
• Homepage: https://ossinsight-lite.vercel.app
• Size: 7.87 MB
• Stars: 384
• Watchers: 7
• Forks: 121
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OSSInsight lite

> 🚧🚧🚧 This project is still in very early version, see [roadmap](https://github.com/pingcap/ossinsight-lite/issues/1).

> Features might be changed before stable release without notification.

> Suggestions and discussions are welcome.

Yet another customizable **FREE** github stats dashboard.

Demo: https://ossinsight-lite.vercel.app/



## Requirements

- **[GitHub](https://github.com.)** account for fork and run your own data pipeline to fetch your GitHub activities.

- **[TiDB Serverless](https://tidbcloud.com/?utm_source=ossinsight&utm_medium=lite)** account to store your personal data for FREE.

- **[Vercel](https://vercel.com/)** account to deploy your dashboards.

## How to deploy your own (10mins)

1. [Create a TiDB Serverless cluster](docs/setup/database.md)

2. [Fork repository and setup GitHub Action to fetch data](docs/setup/repo-and-action.md)

3. [Deploy to Vercel to get your dashboards!](docs/setup/deploy-to-vercel.md)

## Advanced Usage (Optional)

- [Add tracking repos](docs/setup/tracking-repos.md)

- [Private repositories](docs/setup/private-repositories.md)

- TODO: Enable SQL cache

## Roadmap

See [roadmap](https://github.com/pingcap/ossinsight-lite/issues/1)

## Help

- Any feedback is welcome! Please create an [Issue](https://github.com/pingcap/ossinsight-lite/issues/new/choose) or

start a [Discussion](https://github.com/pingcap/ossinsight-lite/discussions/new/choose).

- If your site's home page thrown a 'client side error', Visit `/status` page to see if your database was correctly

configured.

- How to update? You can:

  - manually sync upstream updates if any workflows changed

  - or enable workflow [Sync upstream](.github/workflows/repo-sync.yml) to automatically sync upstream updates, you could set GitHub Action secret `SYNC_GITHUB_TOKEN` to enable auto update workflows. See https://stackoverflow.com/questions/66643917/refusing-to-allow-a-github-app-to-create-or-update-workflow for more

details.

## Use Case

You can add widgets to **README.md** / **websites** / **reports** / **slides** / **profile** by just 4 steps:

  1. 🚀 Deploy your own dashboard

  2. 🔗 Click the share link at the right conner of each widget card

     

     

  3. 📋 Choose a way to add your widget: Markdown, HTML, Link or use Thumbnail img only

     

     

  4. 🤩 Paste and enjoy!

Here are some examples:

| The most used languages | Contribution behavior percentage |

| ----------- | ----------- |

|||

| Contribution monthly | Contribution time distribution |

| ----------- | ----------- |

|||

| Contribution pull request size history | Currently working on |

| ----------- | ----------- |

|||