Repolode
cuixueshe

cuixueshe/earthworm

접속사를 활용해 문장을 만들며 영어를 배우는 TypeScript 웹 앱

스타
11,116
포크
1,358
열린 이슈
11
마지막 커밋
2년 전

어떤 프로젝트인가요?

Earthworm은 접속사를 활용해 문장을 만드는 한 가지 학습법을 중심으로 구성된 영어 학습 앱입니다. 학습자는 연결어로 절을 조합하는 연습을 하며, 이를 통해 단어를 따로 익히는 데 그치지 않고 문장 단위의 영어 실력을 향상할 수 있습니다.

이 프로젝트는 pnpm으로 관리하는 모노레포로, 백엔드는 apps/api에, 클라이언트는 apps/client에 있습니다. 백엔드는 데이터 저장에 Postgres, 캐싱에 Redis, 사용자 인증에 Logto를 사용하며, 이 서비스들은 모두 Docker Compose로 실행합니다. 전용 초기화, 업로드, 업데이트 명령으로 강의 데이터를 데이터베이스에 불러옵니다.

로컬에서 실행하려면 Node.js 20+, pnpm 8+, Docker, Postgres 14+, Redis 5+가 필요합니다. 그런 다음 의존성을 설치하고 .env 파일을 설정한 뒤, 포함된 Logto 데이터를 복원하고 API 및 클라이언트 개발 서버를 실행하면 됩니다. 테스트에는 Vitest, Cypress, Jest를 사용합니다.

핵심 기능

  • 01접속사를 활용해 문장을 만들며 영어 학습
  • 02Postgres와 Redis를 기반으로 하는 백엔드 API
  • 03Logto를 통한 사용자 인증
  • 04로컬 의존 서비스를 실행하는 Docker Compose 구성
  • 05강의 데이터를 초기화, 업로드, 업데이트하는 명령
  • 06Vitest, Cypress, Jest를 활용한 단위 및 엔드 투 엔드 테스트

활용 사례

  • 영어 문법과 문장 구조를 독학
  • 접속사 기반 영어 강의 플랫폼을 로컬에서 실행
  • pnpm 모노레포, Docker, Logto를 사용하는 풀스택 TypeScript 프로젝트 학습

빠른 시작

  1. 1

    corepack을 통해 pnpm을 활성화합니다

    corepack enable
  2. 2

    종속성을 설치합니다

    pnpm install
  3. 3

    서버 환경 파일을 복사합니다

    cp ./apps/api/.env.example ./apps/api/.env
  4. 4

    Docker Compose 서비스(Postgres 및 Redis)를 시작합니다

    pnpm docker:start

사용 전 알아둘 점

  • 로컬 환경에 Postgres, Redis, Docker 및 Node.js 20 이상을 설정해야 합니다.
  • Logto 데이터베이스 덤프 복원과 데이터베이스 스키마 초기화 등을 포함한 여러 단계의 설정이 필요합니다.

토픽

자주 묻는 질문

earthworm은(는) 무엇인가요?
접속사를 활용해 문장을 만들며 영어를 배우는 TypeScript 웹 앱 Earthworm은 접속사를 활용해 문장을 만드는 한 가지 학습법을 중심으로 구성된 영어 학습 앱입니다. 학습자는 연결어로 절을 조합하는 연습을 하며, 이를 통해 단어를 따로 익히는 데 그치지 않고 문장 단위의 영어 실력을 향상할 수 있습니다.
earthworm은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
earthworm은(는) AGPL-3.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
earthworm은(는) 아직 유지보수되고 있나요?
6개월 이상 커밋 없음. earthworm의 마지막 커밋은 2024년 11월 14일입니다.
earthworm은(는) 어디에 사용할 수 있나요?
영어 문법과 문장 구조를 독학 접속사 기반 영어 강의 플랫폼을 로컬에서 실행 pnpm 모노레포, Docker, Logto를 사용하는 풀스택 TypeScript 프로젝트 학습
earthworm는 어떻게 설치하나요?
corepack을 통해 pnpm을 활성화합니다: corepack enable 종속성을 설치합니다: pnpm install 서버 환경 파일을 복사합니다: cp ./apps/api/.env.example ./apps/api/.env Docker Compose 서비스(Postgres 및 Redis)를 시작합니다: pnpm docker:start
earthworm은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/cuixueshe/earthworm

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트