Where to Find Everyone-Can-Use-English Documentation: Complete Guide to Project Resources

You can find everyone-can-use-english documentation in six key locations: the root README for project overview, the FAQ page for app troubleshooting, the book directory for learning content, the enjoy/ folder for Electron app development, the 1000h-portal/ folder for Nuxt 3 portal docs, and the entry/index.js file for API routing details.

The ZuodaoTech/everyone-can-use-english repository is a comprehensive open-source project combining a Mandarin book on English learning with the Enjoy desktop application and supporting web infrastructure. Whether you're a learner, contributor, or developer deploying your own instance, understanding where to find everyone-can-use-english documentation will save you hours of exploration.

Main Entry Point: Root README.md

Start with [README.md](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/README.md) at the repository root. This file serves as the central navigation hub, linking directly to:

• Web application: https://1000h.org
• Browser extension: Chrome and Firefox stores
• Desktop application: macOS, Windows, and Linux releases
• FAQ page: https://1000h.org/enjoy-app/faq.html
• Book chapters: Full table of contents in /book

The README contains no lengthy tutorials—it delegates specialized topics to dedicated files, making it efficient for quick orientation.

FAQ Documentation for End Users

The FAQ lives at https://1000h.org/enjoy-app/faq.html and covers troubleshooting, installation issues, and common usage questions for the Enjoy app. It is maintained as a web page rather than repository markdown, accessible through the link embedded in the root README.

Book Content: Learning Material Documentation

The educational content—the full "人人都能用英语" ("Everyone Can Use English") book—is organized in [book/README.md](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/book/README.md). This directory contains:

• Chapter-by-chapter breakdown of the learning methodology
• Progression from listening practice to speaking confidence
• Reference implementations supporting the book's exercises

This documentation targets learners rather than developers, explaining the 1000-hour immersion approach that the software tools support.

Enjoy App Developer Documentation

The Electron-based Enjoy application—found in the enjoy/ directory—contains inline code documentation across several critical files. These serve as the technical reference for anyone modifying or extending the desktop app.

Renderer Setup and Global API

[enjoy/src/renderer.ts](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/enjoy/src/renderer.ts) documents the Electron renderer environment:

// enjoy/src/renderer.ts – declares the global window object
declare global {
  interface Window {
    __ENJOY_APP__: EnjoyAppType;   // main Enjoy application API
  }
}

// Access pattern used throughout the renderer process
const app = window.__ENJOY_APP__;

This global declaration exposes the main-process API to the renderer, enabling features like audio recording, playback control, and vocabulary management.

Utility Functions

[enjoy/src/utils.ts](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/enjoy/src/utils.ts) contains helper functions with inline documentation for common operations like date formatting, audio processing, and IPC communication wrappers.

Build Configuration

Multiple Vite configuration files document the build pipeline:

File	Purpose
enjoy/vite.main.config.ts	Main Electron process bundling
enjoy/vite.preload.config.ts	Preload script compilation
enjoy/vite.renderer.config.ts	Renderer React frontend builds

These files contain commented configuration options for output directories, external dependencies, and environment-specific settings.

Portal Documentation: 1000h-portal README

The Nuxt 3-based web portal—the frontend for https://1000h.org—is documented in [1000h-portal/README.md](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/1000h-portal/README.md). This file covers:

# Local development setup

cd 1000h-portal
npm install
npm run dev        # Development server at localhost:3000

Additional commands documented include npm run build for static generation and npm run preview for pre-deployment verification. The README specifies Node.js version requirements and environment variable configuration for deployment targets.

API and Infrastructure Documentation

Cloudflare Workers routing logic—the entry point for all web traffic—is implemented in [entry/index.js](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/entry/index.js):

// entry/index.js – routes incoming requests
async function handleRequest(request, env) {
  const { pathname } = new URL(request.url);
  
  if (pathname === '/' || pathname.startsWith('/portal-assets')) {
    return await env.portal.fetch(request);   // Nuxt portal handles assets
  }
  
  return await env.vtp.fetch(request);        // VTP service handles API calls
}

This file documents the production routing architecture: static assets and the portal UI are served by the Nuxt application, while API endpoints are forwarded to the VTP (Voice/Text Processing) backend service. Environment bindings (env.portal, env.vtp) are configured through Cloudflare's Wrangler tooling, with references in adjacent wrangler.toml files.

Documentation Access Patterns by User Type

User Goal	Start Here	Key Files
Learn English method	[book/README.md](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/book/README.md)	Chapter markdown files in book/
Troubleshoot Enjoy app	https://1000h.org/enjoy-app/faq.html	Web FAQ (external)
Develop/modify Enjoy app	enjoy/ directory	renderer.ts, utils.ts, vite.*.config.ts
Deploy custom web portal	[1000h-portal/README.md](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/1000h-portal/README.md)	nuxt.config.ts, deployment scripts
Understand API routing	[entry/index.js](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/entry/index.js)	wrangler.toml

Summary

• Root README.md is the navigation hub linking all everyone-can-use-english documentation resources
• book/README.md contains the full learning curriculum for English acquisition
• External FAQ page (1000h.org/enjoy-app/faq.html) addresses common Enjoy app questions
• enjoy/ directory files (renderer.ts, utils.ts, Vite configs) document the Electron application architecture
• 1000h-portal/README.md provides complete Nuxt 3 portal development instructions
• entry/index.js explains the Cloudflare Workers production routing layer

Frequently Asked Questions

Where is the official FAQ for the Enjoy app?

The official FAQ is hosted at https://1000h.org/enjoy-app/faq.html, linked directly from the root README.md. This external page is maintained separately from the repository and covers installation troubleshooting, audio permissions, subscription management, and feature explanations.

How do I set up the Enjoy app for local development?

Clone the repository, navigate to the enjoy/ directory, and install dependencies. The renderer.ts file documents the global API structure you'll need to interface with, while the Vite configuration files specify the build targets for main, preload, and renderer processes. No centralized development guide exists—you'll read inline comments across these source files.

What documentation exists for deploying my own instance?

[1000h-portal/README.md](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/1000h-portal/README.md) documents Nuxt 3 portal deployment, including static generation and Node.js server modes. For API routing, examine [entry/index.js](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/entry/index.js) to understand how Cloudflare Workers distribute traffic between the portal and backend services—this pattern must be replicated if you're substituting your own infrastructure.

Is there API documentation for backend services?

No standalone API documentation file exists. Backend integration patterns must be inferred from [entry/index.js](https://github.com/ZuodaoTech/everyone-can-use-english/blob/main/entry/index.js), which shows the routing contract between the Workers entry point, the portal environment, and the VTP service environment. For deeper API specifics, you would need to examine the VTP service implementation or network traffic from a running application.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}