README.en-US.md

Everyone Can Use English

Table of Contents

• Introduction
• Chapter 1: Starting Point
• Chapter 2: Spoken Language
• Chapter 3: Pronunciation
• Chapter 4: Reading Aloud
• Chapter 5: Dictionary
• Chapter 6: Grammar
• Chapter 7: Intensive Reading
• Chapter 8: Reminders
• Afterword

Applications

• Enjoy App

* Developers

Local Setup

yarn install
yarn start:enjoy

Compilation

yarn make:enjoy

* Everyday Users

Method 1: The most direct and simple method is to download the appropriate installation file from the releases page.

Method 2: If you want to try out updated versions at any time, follow these steps.

For MacOS Users

1. Open the Terminal command line tool.

2. Install Homebrew (refer to this article: 《从 Terminal 开始…》）

3. Install nodejs and yarn:

   brew install nvm
   nvm install 20.5.1 
   brew install ffmpeg
   brew install yarn

4. Clone this repository locally and then install and launch:

   cd ~
   mkdir github
   cd github
   git clone https://github.com/xiaolai/everyone-can-use-english
   cd ~/github/everyone-can-use-english
   yarn install
   yarn start:enjoy

5. To restart the application, use Terminal:

   cd ~/github/everyone-can-use-english
   git pull
   yarn install
   yarn start:enjoy

For Windows Users

System requirements: Windows 10 version 22H2 or later, Windows PowerShell 5.1 or later, stable internet connection.

1. Right-click on the "Windows logo" in the taskbar and choose "PowerShell".

   Tips 1: On the latest Windows 11, you may not see the "PowerShell" option, only "Terminal".

   Tips 2: Do not run PowerShell with administrator privileges, as it may cause Scoop installation failure.

2. In the opened PowerShell window, execute the following commands to install Scoop:

   # Set PowerShell execution policy
   Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
   # Download installation script
   irm get.scoop.sh -outfile 'install.ps1'
   # Execute installation, --ScoopDir parameter specifies the Scoop installation path
   .\install.ps1 -ScoopDir 'C:\Scoop'

If you encounter the error:

<span style="color:red">irm : Could not resolve this remote name: 'raw.githubusercontent.com'

It indicates a network connection problem; please resolve it on your own.

3. Install Nodejs and yarn as well as other dependencies:

scoop install nodejs
scoop install git
npm install yarn -D

4. Clone this repository locally, and then install the Enjoy App:

   cd ~
   mkdir github
   cd github
   git clone https://github.com/xiaolai/everyone-can-use-english
   cd everyone-can-use-english
   cd enjoy
   yarn install
   yarn start:enjoy

   If you see Completed in XXXXXXXXXX ,it indicates successful installation.

5. Run the Enjoy App by executing the following command in the terminal:

yarn start:enjoy

Update Enjoy

Update and use the latest version of Enjoy:

1. Pull the latest content from the repository locally, execute in the command line tool:

   git pull

   The result should display:

   Already up to date.

2. Run the Enjoy App:

   yarn start:enjoy