diff --git a/README.md b/README.md index 1d48e1d8..a6cdb449 100644 --- a/README.md +++ b/README.md @@ -94,8 +94,11 @@ python -m quant_research_starter.cli compute-factors -d data_sample/sample_price # run a backtest python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json -# optional: start the Streamlit dashboard +# DISCLAIMER: OLD VERSION +# optional: start the Streamlit dashboard, if on main stream streamlit run src/quant_research_starter/dashboard/streamlit_app.py +# NEW VERSION: if streamlit is in legacy folder +streamlit run legacy/streamlit/streamlit_app.py ``` --- diff --git a/src/quant_research_starter/frontend/readme.md b/src/quant_research_starter/frontend/readme.md new file mode 100644 index 00000000..990ed999 --- /dev/null +++ b/src/quant_research_starter/frontend/readme.md @@ -0,0 +1,50 @@ +frontend/ +│ +├── core/ # Shared logic library +│ ├── src/ +│ │ ├── components/ # Shared React components +│ │ ├── hooks/ # Shared React hooks (fetch, state mgmt) +│ │ ├── utils/ # Reusable helper functions +│ │ ├── types/ # Shared TypeScript types +│ │ └── index.ts # Export all shared modules +│ ├── package.json +│ ├── tsconfig.json +│ └── README.md + +│ +├── cauweb/ # Main Web UI App +│ ├── src/ +│ │ ├── pages/ # UI Screens (Home, Dashboard, About) +│ │ ├── layouts/ # Shared layouts (Navbar, Sidebar) +│ │ ├── features/ # Domain features (Logs, Trading UI) +│ │ ├── assets/ # Images, icons, fonts +│ │ ├── styles/ # Global CSS/Tailwind configs +│ │ └── main.tsx # App entry point +│ ├── public/ +│ ├── package.json +│ ├── tsconfig.json +│ └── README.md + +│ +├── cli/ # Terminal UI (Node/React Ink CLI) +│ ├── src/ +│ │ └── index.ts +│ ├── package.json +│ └── tsconfig.json + +│ +├── metrics/ # Data visual charts + API metrics +│ ├── src/ +│ │ ├── charts/ +│ │ ├── analytics/ +│ │ └── index.ts +│ ├── package.json +│ └── tsconfig.json + +│ +├── node_modules/ # Shared dependencies root install +│ +├── package.json # root scripts + global deps +├── pnpm-workspace.yaml # defines workspace packages +├── tsconfig.base.json # shared TS config +└── README.md