Repolode
cuixueshe

cuixueshe/earthworm

接続詞を使って文を組み立てながら、文法や語彙を学べるTypeScript製の英語学習アプリ。

スター
11,118
フォーク
1,359
未解決の Issue
11
最終コミット
2 年前

これは何?

Earthwormは、接続詞を使って文を組み立てることを中心に据えた英語学習プロジェクトです。学習者は接続語を使って節をつなげる練習をします。この方法を軸にプロジェクトが構成されています。

このリポジトリはpnpmモノレポで、apps/clientにVueクライアント、apps/apiにバックエンドAPIがあります。バックエンドではPostgresとRedisを使用し、Docker Composeでローカル起動します。ユーザー認証にはLogtoを使用します。専用のアップロードコマンドでコースデータをデータベースに取り込みます。

セットアップでは、依存関係のインストール、サンプルの.envファイルのコピー、Dockerサービスの起動、データベーススキーマの初期化を行い、APIとクライアントの開発サーバーを起動します。フロントエンドにはVitestとCypress、バックエンドにはJestのテストが用意されています。

主な機能

  • 01接続詞を使って文を組み立てながら英語を学習
  • 02VueクライアントとTypeScript製バックエンドAPIをまとめたpnpmモノレポ
  • 03Docker Composeで提供されるPostgresとRedisのサービス
  • 04Logtoを利用したユーザー認証
  • 05コースデータのインポート・更新コマンド

ユースケース

  • 文を組み立てながら英語の文法を独学
  • Vue、Postgres、Redisを使ったフルスタックTypeScriptアプリの実装例として活用
  • Dockerを使ったローカル開発を含むモノレポ構成の学習

クイックスタート

  1. 1

    corepack経由でpnpmを有効にする

    corepack enable
  2. 2

    依存関係をインストールする

    pnpm install
  3. 3

    サーバー用の環境設定ファイルをコピーし、Docker Composeのサービスを起動する

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

    データベーススキーマを初期化してから、バックエンドとフロントエンドを起動する

    pnpm db:init

使う前に知っておきたいこと

  • セットアップ前にPostgres 14以上、Redis 5以上、Docker、Node.js 20以上をローカルで起動しておく必要があります。
  • Logtoデータの復元や.envファイルの設定など、複数の手動作業が必要です。

トピック

よくある質問

earthworm とは?
接続詞を使って文を組み立てながら、文法や語彙を学べるTypeScript製の英語学習アプリ。 Earthwormは、接続詞を使って文を組み立てることを中心に据えた英語学習プロジェクトです。学習者は接続語を使って節をつなげる練習をします。この方法を軸にプロジェクトが構成されています。
earthworm は無料で使えますか?ライセンスは?
earthworm は AGPL-3.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
earthworm は今もメンテナンスされていますか?
半年以上コミットなし。earthworm の最終コミットは 2024年11月14日 です。
earthworm は何に使えますか?
文を組み立てながら英語の文法を独学 Vue、Postgres、Redisを使ったフルスタックTypeScriptアプリの実装例として活用 Dockerを使ったローカル開発を含むモノレポ構成の学習
earthworm のインストール方法は?
corepack経由でpnpmを有効にする: corepack enable 依存関係をインストールする: pnpm install サーバー用の環境設定ファイルをコピーし、Docker Composeのサービスを起動する: cp ./apps/api/.env.example ./apps/api/.env データベーススキーマを初期化してから、バックエンドとフロントエンドを起動する: pnpm db:init
earthworm はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/cuixueshe/earthworm

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト