Skip to content

Albert-Benavent-Cabrera/Learn-English

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🇬🇧 English Notes Viewer

The ultimate interactive platform for mastering English.

Live Demo: learn-english-teal.vercel.app

This application transforms static study notes into an immersive learning experience. Designed to help students improve pronunciation and comprehension, combining the speed of SSR with the smoothness of a Single Page Application.

  • Instant Text-to-Speech: Interactive, high-fidelity audio reviews.
  • Zero-Flicker Navigation: Seamless, state-preserving transitions.
  • Integrated Video Lessons: Curated YouTube content embedded directly.
  • Exam-Focused Reviews: Structured content organization (A1-B2).

Tech Stack Tech Stack Tech Stack Tech Stack License


🚀 Key Features

  • ⚡ Performance:
    • Direct File Access: High-throughput file reading without redundant caching layers.
    • Optimized Assets: Glassmorphism UI with hardware-accelerated transitions.
  • 🌍 Built-in Translator: Quick access floating widget powered by Google Translate (GTX) for instant word lookup.
  • 📱 Mobile Support:
    • Responsive Sidebar & Touch-friendly tap targets.
    • Smart YouTube embedding (playsinline).
    • Background Playback & PiP: Videos continue playing with screen off or in Picture-in-Picture mode on mobile.

📂 Project Structure

├── app/                  # Source Code
│   ├── server/           # Backend Logic
│   │   ├── index.ts      # Server entry point
│   │   ├── markdownProcessor.ts # Markdown transformations
│   │   └── fileTree.ts   # File system operations
│   ├── src/              # Frontend Logic
│   │   ├── ClientApp.tsx # Client entry point
│   │   ├── components/   # UI Components
│   │   └── App.tsx       # Root Server Component
│   └── public/           # Static Assets
└── contenido/            # Content Storage
    ├── A1/
    ├── A2/
    └── ...

🛠️ Installation & Usage

Prerequisites

  • Node.js v20+ (Required for native features)

Development

cd app
npm install
npm run dev

Starts hybrid server on port 3000 with Hot Module Replacement.

⚡ Easy Launch (Mac & Windows)

If you already have Node.js installed, you can start the application by double-clicking the script for your platform in the root directory:

  • Mac: Double-click dev-mac.command
  • Windows: Double-click dev-windows.bat

These scripts will automatically install dependencies if they are missing and open the browser for you.

Production

cd app
npm run build
npm start

Builds optimized bundle and serves via efficient Node.js production server.

📝 Content Formatting

The system uses advanced Regex to auto-enhance your content. Supported formats:

1. Questions & Answers

Standard format for grammar rules.

- **Question:** What is your name?
- **Answer:** My name is Albert.

2. Vocabulary & Expressions

Optimized for phrase lists.

- **"How are you?"** - ¿Cómo estás?
- **"See you later"** - Hasta luego

The viewer automatically adds interactive speaker icons and highlighting to the bolded English text.

About

Interactive platform to learn English (A1-B2). Free course with Text-to-Speech, audio, and exercises. Curso completo para aprender inglés gratis con audio y pronunciación.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages