cuixueshe /earthworm

Learning English through the method of constructing sentences with conjunctions

★ 11,190⑂ 1,371👁 37⑃ 445● 313▤ 0
TypeScriptCreated 2024-01-11julebu.co
+0
Daily
+0
Weekly
+78
Monthly
11,190
stars
1,371
forks
37
watchers
445
prs
313
issues
0
releases

README

Earthworm
  English | 中文



  
  


 ⚡ Introduction

By constructing sentences with conjunctions, it helps you learn English better~ 😊

 🚀 How To Start?

The mentioned operations below are based on the root directory of the current project, please be attentive to ensure there are no errors!

 Requirements

- pnpm version = 8

  bash
  corepack enable
  

- Node.js version = v20
   Use the version from .node-version. Supported tools
- Postgres version = 14.0.0
- Redis version = 5.0.0
- Docker. please make sure it is installed and running successfully on your local machine.

bash
docker --version  Docker version 24.0.7, build afdd53b

node --version  v20+

pnpm -v  8+


 Editor

 VSCode

- Install the recommended extensions extensions.json

 1. Install Dependencies

bash
pnpm install


 2. Configure the .env File

You can choose to copy the contents of ./apps/api/.env.example to./apps/api/.env. note that the' example' file contains sample configuration. the main storage system's environment variable information, such as database connection address, user name, password, port, key, etc. the back-end service will read the configuration from this file, of course you can also change it to your own configuration information.

Windows users recommend shortcut keys to copy and paste, Linux users can operate through the following command.

 Server

bash
cp ./apps/api/.env.example ./apps/api/.env


 Client

bash
cp ./apps/client/.env.example ./apps/client/.env


 3. Restore Data Of Logto

Uncompress logto_db_init_data.zip to .volumes/

bash
unzip logto_db_init_data.zip -d .volumes/


- Admin URL: http://localhost:3011
- Username: admin
- Password: WkN7g5-i8ZrJckX

 if you want to Manual Configuration Logto

 4. Start Docker Compose Service

The backend relies on Postgres and Redis services. Start and stop these services using the commands configured in package.json below.

bash
 start
pnpm docker:start

 When needed, execute the following command
 stop
pnpm docker:stop
 delete
pnpm docker:delete
 Complete deletion (including Volume data)
pnpm docker:down


If you prefer manual, you can use the commands below.

bash
docker compose up -d
docker compose stop
docker compose down

 commands compatible with older versions of Docker
docker-compose up -d


 5. Initialize Database Schema

When executing this command, try to keep a little time from the previous command, because the -d parameter just used will suspend its service execution in the background. At this time, the docker service may still be running. If an error is found, execute it again.

bash
pnpm db:init


 6. Create and Upload Course Data

Only Execute This During the Initial Database Initialization.

bash
pnpm db:upload


 7. Start the Backend Service

bash
pnpm dev:serve


 8. Start the Frontend Service

bash
pnpm dev:client


 🛠️ About testing

Run the test before submitting the commit, and submit the code after the test passes, so as to avoid multiple commits to solve the test problem.

 Front-end 

Snapshot: 2026-11-04T14:00:00Z · Data license Apache-2.0 · JSON