README.md

Overview

Detox Documentation

Introduction

• Getting Started
• iOS Environment Setup
• Android Environment Setup
• iOS Setup
• Android Setup
• Writing Your First Passing Test
• How Detox Works
• Recommended Workflows With Detox

API Reference

• Detox Configuration
• The detox Object
• The device Object
• Test Lifecycle
• Matchers
• Actions
• Expectations
• Mocking Deep Links (App Launch With URL)
• Mocking User Notifications
• Detox Command Line Tools (detox-cli)
• Test Artifacts
• Taking Screenshots

Troubleshooting

• Troubleshooting Detox Installation
• Troubleshooting a Test That Keeps Failing
• Dealing With Synchronization Issues in Tests
• Dealing With Flakiness in Tests

Guides

• Running Tests Locally on Your Machine
• Developing Your App While Writing Tests
• Running Tests on CI (like Travis)
• Debugging Apps in Xcode During a Test
• Advanced Mocking With Detox
• Migration Between Detox Versions
• Using Jest as Test Runner
• Using Mocha as a Test Runner
• Using Cucumber with Detox
• Parallel Test Execution
• Uninstalling Detox

Under The Hood

• Detox Design Principles

Contributing to Detox

• Detox Contribution Guide
• Detox Development Roadmap
• Android Support - Current Status