MODEL/usda-vision
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Chore: rename api->camera-management-api and web->management-dashboard-web-app; update compose, ignore, README references

Browse Source
This commit is contained in:
Alireza Vaezi
2025-08-07 22:07:25 -04:00
parent 28dab3a366
commit fc2da16728
281 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -4,8 +4,8 @@ A unified monorepo combining the camera API service and the web dashboard for US
## Project Structure
- `api/` - Python API service for camera management (USDA-Vision-Cameras)
- `web/` - React web dashboard for experiment management (pecan_experiments)
- `camera-management-api/` - Python API service for camera management (USDA-Vision-Cameras)
- `management-dashboard-web-app/` - React web dashboard for experiment management (pecan_experiments)
## Quick Start (Docker Compose)
@@ -49,7 +49,7 @@ To stop: `docker compose down`
## Git Subtree Workflow
This repo vendors two upstream projects using git subtree, preserving their histories under `api/` and `web/`.
This repo vendors two upstream projects using git subtree, preserving their histories under `camera-management-api/` and `management-dashboard-web-app/`.
Configured remotes:
@@ -60,20 +60,20 @@ Pull latest upstream changes into subtrees:
```bash
# API (USDA-Vision-Cameras)
git subtree pull --prefix=api cameras master
git subtree pull --prefix=camera-management-api cameras master
# Web (pecan_experiments)
git subtree pull --prefix=web web-origin master
git subtree pull --prefix=management-dashboard-web-app web-origin master
```
Push your changes back upstream (optional):
```bash
# API (push changes made under api/ back to USDA-Vision-Cameras)
git subtree push --prefix=api cameras master
# API (push changes made under camera-management-api/ back to USDA-Vision-Cameras)
git subtree push --prefix=camera-management-api cameras master
# Web (push changes made under web/ back to pecan_experiments)
git subtree push --prefix=web web-origin master
# Web (push changes made under management-dashboard-web-app/ back to pecan_experiments)
git subtree push --prefix=management-dashboard-web-app web-origin master
```
Notes:
@@ -84,13 +84,13 @@ Notes:
## Development Tips
- API
- Code lives under `api/`. The compose service runs `uvicorn usda_vision_system.api.server:app --reload` by default.
- Code lives under `camera-management-api/`. The compose service runs the full system via `python main.py --config config.compose.json`.
- Camera SDK access from inside Docker on Windows may be limited; for hardware work you might run the API directly on the host.
- Configuration: `api/config.json` (see `api/docs` for details).
- Storage (recordings) is mapped to `api/storage/` and ignored by git.
- Configuration: `camera-management-api/config.json` (see `camera-management-api/docs` for details).
- Storage (recordings) is mapped to `camera-management-api/storage/` and ignored by git.
- Web
- Code lives under `web/` with a Vite dev server on port 5173.
- Code lives under `management-dashboard-web-app/` with a Vite dev server on port 5173.
- Environment: set `VITE_SUPABASE_URL` and `VITE_SUPABASE_ANON_KEY` in `.env` (not committed).
- Common scripts: `npm run dev`, `npm run build` (executed inside the container by compose).