Skip to content

Coolomina/paraulins

Repository files navigation

🎙️ Paraulins - Pronunciation Evolution Tracker

Track your children's pronunciation evolution over time with this cozy web application. Record, upload, and organize audio recordings with visual waveform editing.

Python Flask Docker

📺 Screenshot

screenshot

✨ Key Features

  • Multi-child management with individual vocabularies
  • Browser recording or file upload (MP3, WAV, OGG, M4A, WebM)
  • Visual waveform trimming with click-and-drag selection
  • Date-precise tracking (daily, monthly, yearly organization)
  • Image associations for words
  • Mobile-responsive Bootstrap 5 interface
  • Local file storage (no cloud uploads)
  • Image search using Pixabay API (optional). Docs.

🚀 Quick Start

Docker (Recommended)

git clone <repository-url> && cd voices
docker build -t paraulins .
docker run -p 5001:5001 -v $(pwd)/data:/app/data paraulins

Local Development

git clone <repository-url> && cd voices
pdm install
pdm run start

Open http://localhost:5001

🛠️ Development

Setup

pdm install                # Install dependencies
pdm run pre-commit-install # Install pre-commit hooks
pdm run start              # Start development server

Scripts

pdm run test          # Run tests with coverage
pdm run lint          # Run flake8 linting  
pdm run format        # Format with black
pdm run type-check    # Run mypy

📁 Project Structure

voices/
├── app.py                 # Flask application
├── models/               # Data models (Child, Word, Recording)
├── routes/               # API & web routes  
├── services/             # Business logic (Audio, Data, Image)
├── static/               # CSS & JavaScript
├── templates/            # HTML templates
├── tests/                # Test suite
└── data/                 # Storage (JSON + audio/image files)

🎯 Usage

  1. Add children on the home page
  2. Add words for each child
  3. Record audio (browser recording or file upload)
  4. Trim audio using the visual waveform (optional)
  5. Add images to words for visual recognition

🤝 Contributing

Quick start: Fork → Clone → pdm install → Make changes → pdm run test && pdm run lint → Submit PR

License

MIT License - see LICENSE file.

About

Track the evolution of your children's pronunciation over the years

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published