diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..5784b4f --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +NUXT_WEBHOOK_GITHUB_SECRET_KEY= +NUXT_GITHUB_APP_ID= +NUXT_GITHUB_PRIVATE_KEY= diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a13cd3 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# unsight.dev + +> Detect duplicate GitHub issues, areas of concern and more across related repositories + +

+ + Screenshot of unsight.dev showing a cluster of issues on nuxt/nuxt + +

+ +- [👉  Check it out](https://unsight.dev/) + +## ✨ Features + +- Built on [Nuxt](https://nuxt.com/) +- [Nitro server API routes](https://nuxt.com/docs/guide/concepts/server-engine#server-engine) +- [GitHub API](https://docs.github.com/en/rest) and a [GitHub App](https://docs.github.com/en/apps/creating-github-apps) +- [UnoCSS](https://unocss.dev/) +- Deployed on [Cloudflare](https://cloudflare.com/) with [NuxtHub](https://hub.nuxt.com/), using [Workers AI](https://developers.cloudflare.com/workers-ai/#_top), [Workers KV](https://developers.cloudflare.com/kv/#_top) and [Vectorize](http://developers.cloudflare.com/vectorize/) + +## 🛝 Try it out locally + +You can try the app out locally (for tweaking the UI) using the deployed API. + +``` +corepack enable +pnpm i +pnpm dev --ui-only +``` + +This will fire up a dev server but use the remote API to populate it. + +## License + +Made with ❤️ + +Published under [MIT License](./LICENCE).