earthworm

(β˜… 11,003)

Learning English through the method of constructing sentences with conjunctions

  • .editorconfig
  • .gitignore
  • .lintstagedrc.mjs
  • .node-version
  • .prettierignore
  • .simple-git-hooks.js
  • CHANGELOG.md
  • docker-compose.yml
  • LICENSE
  • logto_db_init_data.zip
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • prettier.config.mjs
  • README.md
  • README.zh-CN.md
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/cuixueshe/earthworm

Downloads the entire project code from GitHub to your computer.

cd earthworm

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker --version # Docker version 24.0.7, build afdd53b

Type this command into your terminal and run it.

pnpm docker:start

Type this command into your terminal and run it.

pnpm docker:stop

Type this command into your terminal and run it.

pnpm docker:delete

Type this command into your terminal and run it.

pnpm docker:down

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
pnpm -v # 8+

Type this command into your terminal and run it.

pnpm install

Downloads and installs the libraries listed in package.json.

pnpm docker:start

Type this command into your terminal and run it.

pnpm docker:stop

Type this command into your terminal and run it.

pnpm docker:delete

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation