Update README with Gitea mirror, current project structure, and status

This commit is contained in:
Aiden Smith
2026-02-26 20:01:30 -05:00
parent d91b94d648
commit cba30e37af

View File

@@ -36,8 +36,11 @@ DNS lookup, WHOIS, and domain monitoring tool. Search nameservers, check domain
### Setup
```bash
# Clone and install
# Clone and install (GitHub)
git clone https://github.com/DevVoxel/VectorDNS.git
# Or from Gitea mirror
git clone https://git.pawtime.chat/Meal/VectorDNS.git
cd vectordns
bun install
@@ -75,33 +78,27 @@ app/
page.tsx # Landing page with search
layout.tsx # Root layout (theme, fonts, metadata)
globals.css # Tailwind v4 + shadcn/ui CSS vars
lookup/[domain]/page.tsx # DNS results page (public)
auth/ # Login, signup, OAuth callback
dashboard/ # Authenticated domain tracking
api/
dns/lookup/ # DNS record lookup endpoint
whois/lookup/ # WHOIS lookup endpoint
availability/check/ # Domain availability endpoint
domains/ # Saved domains CRUD
cron/check-domains/ # Daily re-check (Vercel cron)
notifications/ # Notification endpoints
account/page.tsx # User account page
docs/ # Documentation pages
page.tsx # Docs index
layout.tsx # Docs layout with sidebar
api/page.tsx # API documentation
architecture/ # Architecture docs (overview, database, data-flow)
configuration/page.tsx # Configuration guide
self-hosting/page.tsx # Self-hosting guide
roadmap/page.tsx # Visual roadmap page
components/
ui/ # shadcn/ui components
layout/ # Header, footer, sidebar
lookup/ # Search form, record displays
dashboard/ # Domain list, detail, diff views
ui/ # shadcn/ui components (button, card, input, etc.)
site-header.tsx # Shared header with account dropdown
account-dropdown.tsx # Account menu dropdown
domain-search-form.tsx # Domain search input
theme-provider.tsx # next-themes provider
theme-toggle.tsx # Light/dark mode toggle
roadmap-flowchart.tsx # Visual roadmap chart
docs/ # Docs components (sidebar, architecture diagram)
lib/
dns/ # Tangerine DNS service
whois/ # whoiser WHOIS service
availability/ # RDAP availability service
monitoring/ # Change detection + snapshot logic
notifications/ # Notification service
email/ # Resend email functions
supabase/ # Server/client/middleware clients
auth/ # Auth server actions
types/ # Shared TypeScript types
supabase/
migrations/ # SQL schema + RLS policies
types/ # Shared TypeScript types (DNS, WHOIS, availability, database)
utils.ts # Utility functions
```
## Current Status
@@ -111,13 +108,18 @@ supabase/
- [x] Project scaffolding (Next.js 16, Tailwind v4, TypeScript)
- [x] shadcn/ui setup with dark mode (next-themes)
- [x] Landing page with domain search form
- [x] TypeScript type definitions (`lib/types/`) — DNS, WHOIS, availability, database models
- [x] Shared site header with account dropdown
- [x] Account page
- [x] Documentation pages (architecture, API, configuration, self-hosting)
- [x] Visual roadmap page
### TODO
See [ROADMAP.md](./ROADMAP.md) for the full phased build plan. Next up:
- [ ] TypeScript type definitions (`lib/types/`)
- [ ] Supabase schema + migrations + RLS
- [ ] Supabase client setup (`@supabase/ssr`)
- [ ] DNS / WHOIS / availability service layers
- [ ] API routes for public lookups
- [ ] Supabase auth (GitHub, Google, email, magic link)