an-lee 54935aa7e9 Docs: Add enjoy docs (#370)
* init vitepress in enjoy-docs

* update config

* update docs

* upgrade deps

* update settings

* add more docs

* more docs

* update commands

* site config

* add ga

* tweak
2024-03-02 16:36:06 +08:00
2024-03-02 16:36:06 +08:00
2024-01-31 01:40:14 +08:00
2024-01-31 19:53:15 +08:00
2024-03-02 16:36:06 +08:00
2024-03-02 16:36:06 +08:00
2024-02-21 17:22:08 +08:00
2024-02-14 09:43:55 +08:00
2024-03-02 16:36:06 +08:00
2024-01-28 10:04:18 +08:00
2024-03-02 16:36:06 +08:00

Everyone Can Use English

Table of Contents

Applications

* 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.

  1. Install Nodejs and yarn as well as other dependencies:
scoop install nodejs
scoop install git
npm install yarn -D
  1. 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.

  2. 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
    
Description
No description provided
Readme GPL-3.0 270 MiB
Languages
TypeScript 60%
Metal 19.6%
Jupyter Notebook 10.7%
HTML 5.8%
JavaScript 1.7%
Other 2%