Skip to main content

🚀 Quick Start & Onboarding

Welcome to TAFLEX JS! Our onboarding process is designed to get new teams up and running with a fully configured, production-ready framework in under 2 minutes.

Instead of cloning a monolithic repository full of tools you don't need, we utilize a smart interactive Scaffolder.

1. Scaffold Your Modular Project​

The scaffolding script acts as your setup wizard. It analyzes your team's needs and constructs a tailored bounded context.

Open your terminal and execute:

bash <(curl -s https://raw.githubusercontent.com/vinipx/taflex-js-modular/main/scaffold.sh)

The Interactive Wizard​

You will be guided through a series of choices:

  1. Project Identity: Define the path and name (e.g., ./ecommerce-checkout-tests).
  2. Platform Selection: Select only the contexts you need (Web, API, Mobile).
  3. Database Integration: Opt-in to PostgreSQL/MySQL support for data setup.
  4. Reporting Governance: Choose your visibility stack (HTML, Allure, ReportPortal, Xray).

2. Install Your Tailored Dependencies​

Because TAFLEX JS uses a strict plugin architecture, your newly generated package.json only contains the modules you selected.

Navigate to your new project and install:

cd your-project-name
npm install

Note: If you selected Web Testing, this step will also automatically download the necessary Playwright browser binaries.

3. Configure Your Environment​

The Scaffolder automatically generates a .env file containing exactly the variables required by your chosen modules. TAFLEX JS uses strict runtime validation, so you must fill in these values.

Open the .env file:

# Core Execution
EXECUTION_MODE=web
BASE_URL=https://your-staging-environment.com

# Web Module Config
BROWSER=chromium
HEADLESS=true
TIMEOUT=30000

# (Optional) API Module Config
API_BASE_URL=https://api.your-staging-environment.com

4. Understanding the Composition Root​

In your project root, you'll find taflex.setup.js. This is your Composition Root. It registers the specific strategies and schemas your project requires with the core framework.

import { DriverRegistry, configManager } from '@taflex/core';
import { PlaywrightStrategy, WebConfigSchema } from '@taflex/web';

// 1. Register Configuration Schemas for Zod Validation
configManager.registerSchema(WebConfigSchema);

// 2. Register Platform Strategies
DriverRegistry.register('web', PlaywrightStrategy);

If your team's scope expands in the future (e.g., you start doing Mobile testing), you simply npm install @taflex/mobile and add it to this registry!

5. Write and Execute Your First Test​

You are now ready to write tests. Create a file in tests/example.spec.js:

import { test, expect } from './fixtures.js';

test('My First Unified Test', async ({ driver }) => {
    // 1. Navigate
    await driver.navigateTo('/');
    
    // 2. Load Locators
    await driver.loadLocators('home');
    
    // 3. Interact using the unified Driver API
    const title = await driver.findElement('main_heading');
    expect(await title.isVisible()).toBeTruthy();
});

Run the suite:

npm test

🏗️ What's Next for the Team?​

To maximize the framework's potential, we recommend reviewing these architectural deep dives: