Skip to content

Commit 2872437

Browse files
committed
docs: add README and .env.example
1 parent c407349 commit 2872437

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

.env.example

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
NUXT_WEBHOOK_GITHUB_SECRET_KEY=
2+
NUXT_GITHUB_APP_ID=
3+
NUXT_GITHUB_PRIVATE_KEY=

README.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# unsight.dev
2+
3+
> Detect duplicate GitHub issues, areas of concern and more across related repositories
4+
5+
<p align="center">
6+
<a href="https://unsight.dev/" target="_blank">
7+
<img width="1090" alt="Screenshot of unsight.dev showing a cluster of issues on nuxt/nuxt" src="https://github.com/user-attachments/assets/281b5167-eef6-4e08-be50-a6ff047c613b">
8+
</a>
9+
</p>
10+
11+
- [👉 &nbsp;Check it out](https://unsight.dev/)
12+
13+
## ✨ Features
14+
15+
- Built on [Nuxt](https://nuxt.com/)
16+
- [Nitro server API routes](https://nuxt.com/docs/guide/concepts/server-engine#server-engine)
17+
- [GitHub API](https://docs.github.com/en/rest) and a [GitHub App](https://docs.github.com/en/apps/creating-github-apps)
18+
- [UnoCSS](https://unocss.dev/)
19+
- 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/)
20+
21+
## 🛝 Try it out locally
22+
23+
You can try the app out locally (for tweaking the UI) using the deployed API.
24+
25+
```
26+
corepack enable
27+
pnpm i
28+
pnpm dev --ui-only
29+
```
30+
31+
This will fire up a dev server but use the remote API to populate it.
32+
33+
## License
34+
35+
Made with ❤️
36+
37+
Published under [MIT License](./LICENCE).

0 commit comments

Comments
 (0)