Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<p align="center">
<img src="https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey?style=flat-square" alt="Platform" />
<img src="https://img.shields.io/badge/electron-40+-47848F?style=flat-square&logo=electron&logoColor=white" alt="Electron" />
<img src="https://img.shields.io/badge/node-18+-339933?style=flat-square&logo=node.js&logoColor=white" alt="Node.js" />
<img src="https://img.shields.io/badge/node-20.11.0-339933?style=flat-square&logo=node.js&logoColor=white" alt="Node.js" />
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat-square" alt="PRs Welcome" />
</p>

Expand Down Expand Up @@ -159,9 +159,12 @@ for step-by-step instructions on both platforms and how to handle unsigned-app p

### Developers — Build from Source

Recommended Node version is `20.11.0` (see `.nvmrc`).

```bash
git clone https://github.com/iLevyTate/StratoSortCore.git
cd StratoSortCore
nvm use
npm ci
npm run dev
```
Expand Down Expand Up @@ -210,6 +213,7 @@ See **[SECURITY.md](SECURITY.md)** for the complete security policy.
| **[Install Guide](docs/INSTALL_GUIDE.md)** | End-user install (Windows & Mac, no CLI) |
| **[User Guide](docs/USER_GUIDE.md)** | Feature walkthrough for everyday use |
| **[Beta Tester Guide](docs/BETA_TESTER_GUIDE.md)** | Testing + bug reporting for contributors |
| **[E2E Walkthrough](docs/E2E_WALKTHROUGH.md)** | Visual end-to-end walkthrough (UI/media) |
| **[Getting Started](docs/GETTING_STARTED.md)** | Developer setup and build guide |
| **[Architecture](docs/ARCHITECTURE.md)** | System design and data flow |
| **[Graph Features](docs/FEATURES_GRAPH.md)** | Knowledge Graph capabilities |
Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ find the right documentation for your needs.
| Document | Description | Audience |
| -------------------------------------------------------- | ----------------------------------------------------- | -------------- |
| [CONFIG.md](./CONFIG.md) | Installation, dependencies & configuration | All users |
| [E2E_WALKTHROUGH.md](./E2E_WALKTHROUGH.md) | End-to-end app walkthrough (screenshots + videos) | All users |
| [ARCHITECTURE.md](./ARCHITECTURE.md) | High-level system design and data flow | All developers |
| [LEARNING_GUIDE.md](./LEARNING_GUIDE.md) | Codebase learning guide with glossary & code examples | New developers |
| [CODE_QUALITY_STANDARDS.md](./CODE_QUALITY_STANDARDS.md) | Coding standards and style guide | All developers |
Expand Down Expand Up @@ -73,6 +74,7 @@ docs/
├── CODE_QUALITY_STANDARDS.md # Style guide
├── CONFIG.md # Environment variables
├── DI_PATTERNS.md # Dependency injection
├── E2E_WALKTHROUGH.md # End-to-end UI walkthrough (screenshots + videos)
├── ERROR_HANDLING_GUIDE.md # Error patterns
├── FEATURES_GRAPH.md # Knowledge Graph features
├── LEARNING_GUIDE.md # Developer onboarding (glossary + examples)
Expand Down
1 change: 1 addition & 0 deletions test/e2e/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This test suite covers full user flows through the application UI, including:
## Prerequisites

1. **Node.js 18+** - Required for Playwright and Electron
- Recommended: `20.11.0` (see `.nvmrc`)
2. **Build the renderer** - Run `npm run build:dev` before testing
3. **Models downloaded (optional)** - Required for AI analysis tests, but tests handle missing
models gracefully
Expand Down