docs: comprehensive documentation updates for v2.0.0
- Update README.md with Docker quickstart and new features (label management, hacker theme) - Add detailed Docker deployment section to DEPLOYMENT.md: - docker-compose usage - Environment configuration - Data persistence and backup - Container health checks - Troubleshooting steps - Production deployment guidance - Create comprehensive CLAUDE_DESCRIPTION.md: - Project overview and version info - Recent changes in v2.0.0 - Technical stack details - Core features and file structure - State management explanation - Data flow diagrams - API endpoints reference - Development workflow - Customization points - Performance and security notes
This commit is contained in:
parent
a1fa86fe55
commit
83be6bbdfb
4 changed files with 526 additions and 5 deletions
41
README.md
41
README.md
|
|
@ -33,9 +33,29 @@ Candle Annotator provides a TradingView-like charting interface that allows trad
|
|||
- **Delete Tool**: Remove any annotation (markers or lines) by clicking on them
|
||||
- **Tool Toggle**: Click tool button again to deactivate
|
||||
|
||||
### Export
|
||||
### Label Management
|
||||
- **Label Sidebar**: View all annotations in collapsible sidebar with:
|
||||
- **Click Selection**: Click markers on chart or in sidebar to select/highlight
|
||||
- **Keyboard Delete**: Press Delete or Backspace to remove selected label
|
||||
- **Individual Delete**: Delete button on each list item
|
||||
- **Search**: Search annotations by timestamp
|
||||
- **Filter**: Filter by Break Up, Break Down, or All types
|
||||
- **Count Display**: See how many Break Up vs Break Down markers exist
|
||||
- **Visual Highlight**: Selected markers highlighted with glow effect
|
||||
|
||||
### UI Theme
|
||||
- **Hacker Theme**: Terminal-inspired dark aesthetic with:
|
||||
- Matrix green (#00ff41) on dark background (#0a0e0a)
|
||||
- Monospace font (JetBrains Mono) throughout
|
||||
- Glow effects on button hover and active states
|
||||
- Custom scrollbars styled to match theme
|
||||
- High contrast for accessibility
|
||||
|
||||
### Export & Deployment
|
||||
- **CSV Export**: Download all annotations with timestamp, label type, and price data
|
||||
- **ML-Ready Format**: Structured data suitable for training ML models
|
||||
- **Docker Deployment**: One-command deployment with persistent data volume
|
||||
- **Health Check**: Built-in /api/health endpoint for monitoring
|
||||
|
||||
## Tech Stack
|
||||
|
||||
|
|
@ -50,13 +70,26 @@ Candle Annotator provides a TradingView-like charting interface that allows trad
|
|||
|
||||
## Getting Started
|
||||
|
||||
### Docker Quickstart (Recommended)
|
||||
|
||||
The fastest way to get running with Docker:
|
||||
|
||||
```bash
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
Then open http://localhost:3000
|
||||
|
||||
See [DEPLOYMENT.md](./DEPLOYMENT.md#docker-deployment) for detailed Docker instructions.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js 18.x or higher
|
||||
- npm 9.x or higher
|
||||
- Node.js 18.x or higher (for local development)
|
||||
- npm 9.x or higher (for local development)
|
||||
- Docker & docker-compose (for containerized deployment)
|
||||
- Build tools for native modules (see DEPLOYMENT.md)
|
||||
|
||||
### Installation
|
||||
### Local Development Installation
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue