# System Requirements for Running Everyone-Can-Use-English: Complete Setup Guide

> Discover the system requirements for running Everyone-Can-Use-English. Ensure you have Node.js v16+, Yarn v4+, and a modern browser for a smooth setup.

- Repository: [Zuodao/everyone-can-use-english](https://github.com/ZuodaoTech/everyone-can-use-english)
- Tags: getting-started
- Published: 2026-08-14

---

**To run Everyone-Can-Use-English, you need Node.js v16+, Yarn v4+, a modern web browser, and optionally Python 3.8+ with JupyterLab for advanced notebooks.**

Everyone-Can-Use-English is an open-source English learning platform developed by ZuodaoTech that combines a web-based interface with optional desktop and browser extension components. Understanding the **system requirements** ensures a smooth installation whether you're accessing the hosted web version at `https://enjoy.bot` or running the entire stack locally for development and customization.

## Core Runtime Requirements

The project is fundamentally a **Node.js application** with a complex build pipeline managed through modern JavaScript tooling.

### Node.js and Yarn Versions

According to the repository's [`package.json`](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/package.json) and [`.yarnrc.yml`](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/.yarnrc.yml), you must have:

| Component | Minimum Version | Verification |
|-----------|---------------|--------------|
| **Node.js** | v16 or newer | Check with `node --version` |
| **Yarn** | v4.6 or newer | Check with `yarn --version` |

The project uses **Yarn 4** specifically, which relies on recent Node.js features for its Plug'n'Play (PnP) module resolution. The [`.yarnrc.yml`](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/.yarnrc.yml) file in the repository root configures this requirement explicitly.

> **Note:** Standard npm will not work. The build scripts and workspace management depend on Yarn 4's specific behavior.

### Operating System Support

The **system requirements** are broadly compatible across platforms:

- **Windows:** Windows 10 or 11 (64-bit)
- **macOS:** macOS 10.15 (Catalina) or later
- **Linux:** Any recent distribution with standard glibc

These requirements apply to the desktop client and local development. The web version at `https://enjoy.bot` has no OS restrictions beyond browser capability.

## Web Browser Requirements

For accessing the Enjoy web interface and browser extension:

- **Chrome/Edge/Brave:** Any Chromium-based browser, current stable version
- **Firefox:** Current stable version

The browser extension is distributed through the Chrome Web Store and requires extension API support.

## Optional Python Environment for Jupyter Notebooks

The repository includes advanced speech-training workflows in `new-edition-drafts/jupyter-notebooks/`. Running these adds Python-based **system requirements**:

| Component | Version | Purpose |
|-----------|---------|---------|
| **Python** | 3.8 or newer | Notebook kernel execution |
| **pip** | Latest | Package management |
| **JupyterLab** | 3.x or newer | Interactive notebook interface |

Key notebooks include:
- `new-edition-drafts/jupyter-notebooks/spaCy.ipynb` — NLP processing pipelines
- `new-edition-drafts/jupyter-notebooks/eng-to-ipa.ipynb` — English to IPA transcription

The documentation at `new-edition-drafts/第一轮讲解/在本地安装 Jupyter 以及 JupyterLab-Desktop.md` provides detailed installation steps for this optional component.

## Network and Hardware Requirements

### Internet Connection

- **Minimum:** 5 Mbps broadband
- **Used for:** Dependency downloads, cloud service access, audio streaming, language model fetching

### Audio Hardware

- **Required:** System audio output (speakers or headphones)
- **Recommended:** Microphone for pronunciation recording features

## Complete Installation Example

Here's a verified setup sequence that satisfies all **system requirements**:

```bash

# Install Node.js 18 (LTS) and Yarn 4

curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs
npm install -g yarn@4

# Clone and configure

git clone https://github.com/ZuodaoTech/everyone-can-use-english.git
cd everyone-can-use-english
yarn install

# Start development server

yarn dev

```

Access the local instance at `http://localhost:3000`.

### Optional Python Setup

```bash

# Create isolated Python environment

python3 -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate

# Install Jupyter ecosystem

pip install jupyterlab notebook

# Launch specific notebook

jupyter lab new-edition-drafts/jupyter-notebooks/eng-to-ipa.ipynb

```

## Component-Specific Requirements Breakdown

### For Web-Only Usage

If you only need the hosted platform:

- Modern web browser
- Internet connection
- Audio output device

No local installation required. Navigate to `https://enjoy.bot`.

### For Local Development

Full **system requirements** including the "enjoy" desktop application:

- Node.js ≥16
- Yarn 4
- Compatible operating system
- Git for repository cloning

### For Notebook Workflows

Add Python stack to base requirements:

- Python 3.8+
- pip package manager
- JupyterLab 3+

## Verifying Your Installation

Run these checks to confirm your environment meets **system requirements**:

```bash

# Verify Node and Yarn

node --version    # Expected: v16.x.x or higher

yarn --version    # Expected: 4.x.x

# Verify Python (if using notebooks)

python3 --version  # Expected: 3.8.x or higher

jupyter --version  # Lists JupyterLab and related packages

```

## Summary

- **Node.js v16+ and Yarn v4+** are mandatory for any local installation
- **Modern browser** suffices for web-only access to `https://enjoy.bot`
- **Python 3.8+ with JupyterLab** enables advanced notebook workflows in `new-edition-drafts/jupyter-notebooks/`
- **Windows 10/11, macOS 10.15+, or modern Linux** support all platform features
- Repository files [`package.json`](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/package.json), [`.yarnrc.yml`](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/.yarnrc.yml), and [`README.md`](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/README.md) (lines 17-32) codify these **system requirements**

## Frequently Asked Questions

### Can I run Everyone-Can-Use-English without installing Node.js?

No. While the hosted web version at `https://enjoy.bot` requires only a browser, any local development, customization, or desktop client usage requires Node.js v16+ and Yarn 4 as specified in the root [`package.json`](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/package.json). The build system, dependency management, and application runtime all depend on these tools.

### Is Python required for basic usage?

No. Python and JupyterLab are only needed if you want to run the interactive notebooks in `new-edition-drafts/jupyter-notebooks/`. These support advanced speech analysis workflows but are entirely optional for the core English learning experience.

### What if I have an older version of Node.js installed?

Upgrade to at least Node.js v16 before attempting installation. Yarn 4 uses modern JavaScript features not available in earlier Node versions. The repository does not support legacy Node.js runtimes, and `yarn install` will fail with incompatibility errors.

### Can I use npm instead of Yarn?

No. The repository is configured specifically for Yarn 4 with Plug'n'Play module resolution. The [`.yarnrc.yml`](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/.yarnrc.yml) file enforces this, and build scripts expect Yarn's workspace behavior. Using npm will result in dependency resolution failures.