Repolode
cuixueshe

cuixueshe/earthworm

Una aplicación para aprender inglés con TypeScript que enseña gramática y vocabulario mediante la construcción de oraciones con conjunciones.

Estrellas
11,118
Forks
1,359
Issues abiertos
11
Último commit
hace 2 años

¿Qué es?

Earthworm es un proyecto para aprender inglés basado en construir oraciones con conjunciones. Los estudiantes practican cómo combinar cláusulas con conectores, el método central en torno al cual se organiza el proyecto.

El repositorio es un monorepo de pnpm con un cliente Vue en apps/client y una API backend en apps/api. El backend usa Postgres y Redis, que se inician localmente mediante Docker Compose, y Logto se utiliza para la autenticación de usuarios. Los datos de los cursos se cargan en la base de datos mediante un comando específico.

La configuración requiere instalar las dependencias, copiar los archivos .env de ejemplo, iniciar los servicios de Docker, inicializar el esquema de la base de datos y ejecutar los servidores de desarrollo de la API y el cliente. El proyecto incluye pruebas con Vitest y Cypress para el frontend, y pruebas con Jest para el backend.

Funciones clave

  • 01Enseña inglés mediante la construcción de oraciones con conjunciones
  • 02Cliente Vue y API backend con TypeScript en un solo monorepo de pnpm
  • 03Servicios de Postgres y Redis proporcionados mediante Docker Compose
  • 04Autenticación de usuarios basada en Logto
  • 05Comandos para importar y actualizar datos de cursos

Casos de uso

  • Estudiar gramática inglesa por cuenta propia mediante la construcción de oraciones
  • Implementación de referencia de una aplicación full-stack con TypeScript, Vue, Postgres y Redis
  • Estudiar una configuración de monorepo con desarrollo local basado en Docker

Inicio rápido

  1. 1

    Activa pnpm con corepack

    corepack enable
  2. 2

    Instala las dependencias

    pnpm install
  3. 3

    Copia el archivo de entorno del servidor e inicia los servicios de Docker Compose

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

    Inicializa el esquema de la base de datos y, después, inicia el backend y el frontend

    pnpm db:init

Antes de usarlo

  • Antes de la instalación, deben estar ejecutándose localmente Postgres 14 o superior, Redis 5 o superior, Docker y Node.js 20 o superior.
  • La configuración requiere varios pasos manuales, como restaurar los datos de Logto y configurar los archivos .env.

Temas

Preguntas frecuentes

¿Qué es earthworm?
Una aplicación para aprender inglés con TypeScript que enseña gramática y vocabulario mediante la construcción de oraciones con conjunciones. Earthworm es un proyecto para aprender inglés basado en construir oraciones con conjunciones. Los estudiantes practican cómo combinar cláusulas con conectores, el método central en torno al cual se organiza el proyecto.
¿earthworm es gratuito? ¿Qué licencia tiene?
earthworm es open source bajo la licencia AGPL-3.0. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿earthworm sigue mantenido?
Sin commits en más de 6 meses. El último commit de earthworm fue el 14 nov 2024.
¿Para qué puedo usar earthworm?
Estudiar gramática inglesa por cuenta propia mediante la construcción de oraciones Implementación de referencia de una aplicación full-stack con TypeScript, Vue, Postgres y Redis Estudiar una configuración de monorepo con desarrollo local basado en Docker
¿Cómo se instala earthworm?
Activa pnpm con corepack: corepack enable Instala las dependencias: pnpm install Copia el archivo de entorno del servidor e inicia los servicios de Docker Compose: cp ./apps/api/.env.example ./apps/api/.env Inicializa el esquema de la base de datos y, después, inicia el backend y el frontend: pnpm db:init
¿Dónde consigo earthworm?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/cuixueshe/earthworm

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados