mirror of
https://github.com/NicholaiVogel/dashore-incubator.git
synced 2026-04-17 22:25:03 +00:00
Nicholai
2e051e4bef
- add WorkOS AuthKit authentication with middleware protection - add dashboard with sidebar layout (shadcn/ui components) - add contributor documentation (CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, START-HERE, Documentation/) - add CI workflow for lint and build on PRs - switch from pnpm to bun - add CLAUDE.md and AGENTS.md for AI assistant context
40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
Documentation
|
|
===
|
|
|
|
contributor guides and reference documentation for dashore incubator.
|
|
|
|
quick reference
|
|
---
|
|
|
|
| Document | Purpose |
|
|
|----------|---------|
|
|
| [../START-HERE.md](../START-HERE.md) | Quick start for new contributors |
|
|
| [../CONTRIBUTING.md](../CONTRIBUTING.md) | Contribution workflow overview |
|
|
| [commit-messages.md](commit-messages.md) | Commit message format |
|
|
| [pull-requests.md](pull-requests.md) | PR workflow and guidelines |
|
|
| [../CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) | Community standards |
|
|
| [../SECURITY.md](../SECURITY.md) | Security vulnerability reporting |
|
|
|
|
for new contributors
|
|
---
|
|
|
|
1. start with [START-HERE.md](../START-HERE.md) to set up your environment
|
|
2. read [CONTRIBUTING.md](../CONTRIBUTING.md) for the workflow overview
|
|
3. check [commit-messages.md](commit-messages.md) before your first commit
|
|
4. review [pull-requests.md](pull-requests.md) before opening a PR
|
|
|
|
project context
|
|
---
|
|
|
|
- **CLAUDE.md** in the repo root has AI assistant context and project architecture
|
|
- the codebase uses Next.js 15 with App Router, deployed to Cloudflare Workers
|
|
- authentication is handled by WorkOS AuthKit
|
|
- UI components are from shadcn/ui
|
|
|
|
getting help
|
|
---
|
|
|
|
- **discord:** join our community
|
|
- **issues:** check existing issues or create a new one
|
|
- **discussions:** for questions and ideas
|