Getting Started

Quantex is a comprehensive text analysis platform that delivers readability scores, style checks, tone analysis, and argument structure insights. This guide walks you through your first analysis, the core interface, and key interactions.

Quick Start (Web App)

The fastest way to start is the hosted web application at https://quantex.codecide.net. No installation is required.

Open the URL in a modern browser.
The editor is pre-filled with sample text. You can replace it with your own content.
Analysis runs automatically as you type or paste text. Results appear in the tabbed dashboard below the editor.

Running Locally (Developers)

If you have access to the source code and want to run Quantex on your own machine, follow these steps.

Prerequisites

Node.js >= 18
npm >= 9

Installation

# Clone the repository (replace <repo-url> with the actual URL)
git clone <repo-url> quantex
cd quantex
npm install

Configuration

Copy the example environment file and adjust values as needed:

cp .env.example .env

Key environment variables:

Variable	Default	Description
`NODE_ENV`	`production`	Runtime environment
`PORT`	`3000`	API server port
`ALLOWED_ORIGINS`	—	Comma-separated CORS origins
`API_RATE_LIMIT_REQUESTS`	`100`	Max requests per rate-limit window
`API_RATE_LIMIT_WINDOW`	`60000`	Rate-limit window in ms
`VITE_USE_API`	`false`	Route analysis through the API server instead of client-side
`VITE_ENABLE_FILE_EXTRACTORS`	—	Enable `.docx`/`.pdf` file upload

Development Servers

Start the web development server:

npm run dev:web

Start the API development server (optional, for remote analysis):

npm run dev:api

Production Build

Build all packages in dependency order:

npm run build

The build order is: shared-types → shared-logic → api-server → web.

Docker

To run both the web app and API server with Docker:

docker compose up --build

Web app served by Nginx on port 80
API server on port 3000

Core UI Walkthrough

The interface is divided into three main areas: the top bar, the text input panel, and the analysis dashboard.

Top Bar

The top bar provides quick access to:

Logo / Home – returns to the main view.
A/B Compare – toggles side-by-side text comparison mode.
Writing Goals – opens a modal to set word count, readability, or reading time targets.
Analysis Options – opens a modal to configure language, readability, style sensitivity, and argument structure settings.
Help – opens a guide with keyboard shortcuts and feature descriptions.
Dark mode toggle – switches between light and dark themes.

Text Input Panel

The left panel (or top on small screens) contains the main text editor. You can:

Type or paste plain text, Markdown, or HTML.
Upload files: .txt, .md, .html, .htm, and (if enabled) .docx and .pdf. Maximum file size is 2 MB.
Choose an input format mode: Auto (default), Plain, Markdown, or HTML. The app strips markup before analysis.
See live character, word, sentence, and paragraph counts below the editor.
Use the Clear button to reset the editor.

Analysis Dashboard

Results are organised into nine tabs. Each tab presents specific insights with KPI cards, charts, and detailed tables.

Tab	What You’ll Find
Overview	Summary counts, reading time, average word/sentence length, top keywords.
Structure	Argument structure: thesis, supporting points, conclusion, coherence, and logical flow.
Sentences	Sentence length distribution, variety metrics, longest/shortest sentences.
Diversity	Vocabulary richness, type-token ratio, hapax legomena, word frequency.
Readability	Flesch Reading Ease, Flesch-Kincaid Grade Level, Gunning Fog Index, CEFR level.
Patterns	N-gram frequency analysis, character frequency, palindrome detection.
Style	Passive voice, adverbs, weak verbs, cliches, filler words, complex sentences.
Tone	Sentiment analysis, emotional tone, formality level.
Recommendations	Actionable writing suggestions based on detected issues.

KPI cards include tooltips that explain the metric and its formula. Interactive charts (histograms, gauges, line charts) help visualise the data.

Key Interactions

Analyse Text

Analysis runs automatically whenever the text or options change. You can also trigger a manual re-analysis by modifying the text or toggling an option.

Compare Two Texts

Click the A/B Compare button in the top bar.
Two editors appear side by side. Paste or type text into each.
Each side is analysed independently using the same options.
Tabs show results for both texts, making it easy to spot differences.

Configure Analysis Options

Click the Settings icon to open the options modal. You can adjust:

Language – affects syllable counting, stopwords, and readability formulas.
Readability – enable/disable specific scores.
Style Sensitivity – set thresholds for passive voice, adverbs, complex sentences, etc.
Argument Structure – enable/disable, set confidence thresholds, strictness, and issue detection.

Changes take effect immediately.

Set Writing Goals

Click the Target icon to define goals:

Word count – minimum or maximum target.
Readability – target grade level.
Reading time – maximum minutes.

The dashboard will show progress indicators against your goals.

Export and Import Results

Export – from the top bar, choose JSON, CSV, or PDF. The exported file contains all analysis data.
Import – load a previously exported JSON file to restore an analysis session.

Keyboard Shortcuts

Press ? or open the Help modal to see all available shortcuts. Common ones include:

Ctrl/Cmd + Enter – trigger analysis
Ctrl/Cmd + Shift + C – toggle compare mode
Ctrl/Cmd + , – open options modal

Session Persistence

Your text, options, and active tab are saved automatically in your browser’s session storage. When you reopen the app, your last session is restored.

Next Steps

Explore the API at /api/docs for programmatic analysis. The API accepts a POST /api/analyze request with JSON body { "text": "...", "options": {...} }.
Check the Enterprise plan for advanced features and support at https://quantex.codecide.net/enterprise.
For development, refer to the project README for testing, linting, and build commands.