Initial commit: Add project README
This commit is contained in:
38
README.md
Normal file
38
README.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# USDA Vision
|
||||||
|
|
||||||
|
A unified project combining camera API services and web dashboard for USDA vision experiments.
|
||||||
|
|
||||||
|
## Project Structure
|
||||||
|
|
||||||
|
- `api/` - Python API service for camera management (USDA-Vision-Cameras)
|
||||||
|
- `web/` - React web dashboard for experiment management (pecan_experiments)
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Start all services
|
||||||
|
docker-compose up -d
|
||||||
|
|
||||||
|
# Development mode
|
||||||
|
docker-compose -f docker-compose.dev.yml up
|
||||||
|
```
|
||||||
|
|
||||||
|
## Services
|
||||||
|
|
||||||
|
### API Service (Port 8000)
|
||||||
|
- Camera management endpoints
|
||||||
|
- Video recording controls
|
||||||
|
- File management
|
||||||
|
|
||||||
|
### Web Dashboard (Port 3000)
|
||||||
|
- User authentication via Supabase
|
||||||
|
- Experiment definition and management
|
||||||
|
- Camera control interface
|
||||||
|
- Video playback and analysis
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
Each service can be developed independently:
|
||||||
|
|
||||||
|
- API: See `api/README.md`
|
||||||
|
- Web: See `web/README.md`
|
||||||
Reference in New Issue
Block a user