forked from 0xWheatyz/SPARC
docs: update documentation for React frontend and cache mode
Update all documentation to reflect recent changes: - Replace Streamlit dashboard references with React TypeScript dashboard - Update dashboard port from 8501 to 8080 - Add auth.py and database.py to architecture section - Change USE_DATABASE terminology to USE_CACHE - Add JWT_SECRET to environment variables reference - Document default admin credentials and user seeding 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -17,7 +17,7 @@ SPARC automatically collects, parses, and analyzes patents from companies to pro
|
||||
- **Portfolio Analysis**: Evaluates multiple patents holistically for comprehensive insights
|
||||
- **Batch Processing**: Analyze multiple companies concurrently with progress tracking
|
||||
- **REST API**: FastAPI web service with async job support
|
||||
- **Dashboard**: Interactive Streamlit visualization dashboard
|
||||
- **Dashboard**: React TypeScript web dashboard with authentication
|
||||
- **Robust Testing**: 40 tests covering all major functionality
|
||||
|
||||
## Architecture
|
||||
@@ -27,7 +27,9 @@ SPARC/
|
||||
├── serp_api.py # Patent retrieval and PDF parsing
|
||||
├── llm.py # Claude AI integration via OpenRouter
|
||||
├── analyzer.py # High-level orchestration
|
||||
├── api.py # FastAPI web service
|
||||
├── api.py # FastAPI web service with auth endpoints
|
||||
├── auth.py # JWT authentication module
|
||||
├── database.py # PostgreSQL storage with caching
|
||||
├── types.py # Data models
|
||||
└── config.py # Environment configuration
|
||||
```
|
||||
@@ -48,7 +50,7 @@ docker-compose up -d
|
||||
|
||||
# Access the services
|
||||
# - API: http://localhost:8000
|
||||
# - Dashboard: http://localhost:8501
|
||||
# - Dashboard: http://localhost:8080
|
||||
# - API Docs: http://localhost:8000/docs
|
||||
```
|
||||
|
||||
@@ -186,21 +188,22 @@ curl -X POST http://localhost:8000/analyze/batch/async \
|
||||
-d '{"companies": ["nvidia", "amd", "intel", "qualcomm"]}'
|
||||
```
|
||||
|
||||
### Visualization Dashboard
|
||||
### Web Dashboard
|
||||
|
||||
Launch the interactive Streamlit dashboard:
|
||||
The React dashboard is included in Docker Compose:
|
||||
|
||||
```bash
|
||||
streamlit run dashboard.py
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Dashboard features:
|
||||
- **Authentication**: User registration, login, and JWT-based sessions
|
||||
- **Company Analysis**: Analyze individual companies with real-time results
|
||||
- **Batch Analysis**: Process multiple companies with progress tracking and charts
|
||||
- **Analytics**: View historical analysis data and trends (requires database mode)
|
||||
- **System Status**: Monitor database and analyzer health
|
||||
- **Batch Analysis**: Process multiple companies with progress tracking
|
||||
- **Analytics**: View historical analysis data and trends
|
||||
- **Admin Panel**: User management for administrators
|
||||
|
||||
The dashboard runs at `http://localhost:8501` by default.
|
||||
The dashboard runs at `http://localhost:8080` when using Docker Compose.
|
||||
|
||||
## Running Tests
|
||||
|
||||
@@ -280,4 +283,4 @@ For open source projects, say how it is licensed.
|
||||
|
||||
Core functionality complete. Ready for production use with API keys configured.
|
||||
|
||||
All major features implemented: REST API, Streamlit dashboard, Docker containerization, database storage, and multi-company batch processing.
|
||||
All major features implemented: REST API, React dashboard with authentication, Docker containerization, database storage with caching, and multi-company batch processing.
|
||||
|
||||
Reference in New Issue
Block a user