“BeeRad”
733d1c3407
Local-first knowledge management system with BYO API keys. Features: - 3-panel UI (Nodes | Focus | Helpers) - SQLite + sqlite-vec for vector search - Agent system (Easy/Hard mode orchestrators) - Content extraction (YouTube, PDF, web) - Integrate workflow for connection discovery - Dimension system with auto-assignment Tech stack: - Next.js 15 + TypeScript + Tailwind CSS - Anthropic (Claude) + OpenAI (GPT) via Vercel AI SDK Setup: npm install && npm rebuild better-sqlite3 scripts/dev/bootstrap-local.sh npm run dev MIT License
125 lines
3.3 KiB
Markdown
125 lines
3.3 KiB
Markdown
# Pull Request
|
|
|
|
## Description
|
|
Brief description of what this PR does and why.
|
|
|
|
## Type of Change
|
|
Please delete options that are not relevant.
|
|
|
|
- [ ] Bug fix (non-breaking change which fixes an issue)
|
|
- [ ] New feature (non-breaking change which adds functionality)
|
|
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
|
- [ ] Documentation update
|
|
- [ ] Code refactoring (no functional changes)
|
|
- [ ] Performance improvement
|
|
- [ ] Test coverage improvement
|
|
|
|
## Related Issues
|
|
Closes #[issue number]
|
|
Related to #[issue number]
|
|
|
|
## Changes Made
|
|
- [ ] Change 1: Description
|
|
- [ ] Change 2: Description
|
|
- [ ] Change 3: Description
|
|
|
|
## How Has This Been Tested?
|
|
Please describe the tests that you ran to verify your changes:
|
|
|
|
- [ ] Unit tests
|
|
- [ ] Integration tests
|
|
- [ ] Manual testing
|
|
- [ ] API endpoint testing (if applicable)
|
|
- [ ] Database operations verified
|
|
- [ ] UI/UX testing (if applicable)
|
|
|
|
### Test Configuration
|
|
- Node.js version: [e.g., 18.17.0]
|
|
- Operating System: [e.g., macOS 13.5]
|
|
- Database: [e.g., PostgreSQL 15 with pgvector]
|
|
|
|
## Screenshots/Videos
|
|
If applicable, add screenshots or videos to demonstrate the changes.
|
|
|
|
### Before
|
|
[Screenshot/description of before state]
|
|
|
|
### After
|
|
[Screenshot/description of after state]
|
|
|
|
## Database Changes
|
|
- [ ] No database changes
|
|
- [ ] Schema changes (describe below)
|
|
- [ ] Migration required
|
|
- [ ] Seeds/fixtures updated
|
|
|
|
If database changes are made, describe them:
|
|
```sql
|
|
-- Example of schema changes
|
|
```
|
|
|
|
## API Changes
|
|
- [ ] No API changes
|
|
- [ ] New endpoints added
|
|
- [ ] Existing endpoints modified
|
|
- [ ] Breaking changes to API
|
|
|
|
If API changes are made, describe them:
|
|
```typescript
|
|
// Example of API changes
|
|
```
|
|
|
|
## Performance Impact
|
|
- [ ] No performance impact expected
|
|
- [ ] Performance improvement
|
|
- [ ] Potential performance impact (explain below)
|
|
|
|
## Security Considerations
|
|
- [ ] No security implications
|
|
- [ ] Security improvement
|
|
- [ ] Potential security impact (explain below)
|
|
|
|
## Documentation
|
|
- [ ] Documentation updated
|
|
- [ ] No documentation changes needed
|
|
- [ ] Documentation to be updated in separate PR
|
|
|
|
## Checklist
|
|
- [ ] My code follows the style guidelines of this project
|
|
- [ ] I have performed a self-review of my code
|
|
- [ ] I have commented my code, particularly in hard-to-understand areas
|
|
- [ ] I have made corresponding changes to the documentation
|
|
- [ ] My changes generate no new warnings or errors
|
|
- [ ] I have added tests that prove my fix is effective or that my feature works
|
|
- [ ] New and existing unit tests pass locally with my changes
|
|
- [ ] Any dependent changes have been merged and published
|
|
|
|
## Deployment Notes
|
|
Special instructions for deploying this change:
|
|
- [ ] No special deployment requirements
|
|
- [ ] Environment variables need to be updated
|
|
- [ ] Database migration required
|
|
- [ ] External service configuration needed
|
|
|
|
## Breaking Changes
|
|
If this introduces breaking changes, describe the migration path:
|
|
|
|
## Additional Notes
|
|
Any additional information that reviewers should know:
|
|
|
|
---
|
|
|
|
## For Reviewers
|
|
### Review Focus Areas
|
|
Please pay special attention to:
|
|
- [ ] Code quality and style
|
|
- [ ] Test coverage
|
|
- [ ] Performance implications
|
|
- [ ] Security considerations
|
|
- [ ] Documentation accuracy
|
|
|
|
### Testing Instructions
|
|
Specific steps for reviewers to test this change:
|
|
1. Step 1
|
|
2. Step 2
|
|
3. Step 3 |