Skip to content

mrwrite/echoed

Repository files navigation

EchoEd

CI Docker

EchoEd is an open-source education platform centered on African and African-American history. It is being prepared for public community review and contribution from educators, developers, students, homeschool leaders, HBCU communities, and community learning organizers across the United States, Africa, and the Caribbean.

Current public app: https://echoed-theta.vercel.app/
Repository: https://github.com/mrwrite/echoed
License: MIT

Current Status

EchoEd is early and pre-community-launch.

  • Working K-5 demo exists with student, teacher, and admin experiences.
  • Demo access uses shared demo-only credentials.
  • The project has no current public users, contributors, stars, advisors, or community traction.
  • Phase 1 focuses on trust, documentation, contributor onboarding, and public demo readiness before broad outreach begins.

Do not enter personal, student, school, or production data into the demo.

Mission

EchoEd exists to make culturally grounded Black history learning experiences easier to explore, teach, review, and improve in public. The project aims to combine rigorous historical learning, accessible product design, and open-source community ownership.

Who This Is For

Educators

EchoEd needs classroom judgment before it needs scale. Educators can help by reviewing demo flows, lesson tone, age fit, source needs, discussion prompts, and classroom usefulness.

Start here:

Developers

EchoEd is an Angular and FastAPI application. Developers can help with frontend polish, accessibility, backend tests, demo reliability, documentation, curriculum tooling, and contributor onboarding.

Start here:

  • Read CONTRIBUTING.md.
  • Review ARCHITECTURE.md.
  • Look for issues labeled good first issue, help wanted, documentation, frontend, backend, testing, accessibility, or demo.

Community Organizers

Community organizers can help connect EchoEd with Black educator networks, homeschool groups, HBCU programs, Black developer groups, and Africa or Caribbean education technology communities.

Start here:

Public Demo

The live app is available at https://echoed-theta.vercel.app/.

Use the demo only for evaluation. Demo credentials and walkthrough steps are documented in docs/public-demo.md. The credentials are shared, demo-only, resettable, and not appropriate for real learner data.

Project Structure

backend/      FastAPI app, SQLAlchemy models, Alembic migrations, pytest tests
frontend/     Angular app, Tailwind styling, Playwright demo smoke tests
docs/         Demo, outreach, and project guidance
openspec/     Spec-driven change workflow
curriculum/   Seed curriculum and package material

For a deeper overview, see ARCHITECTURE.md.

Local Development

Backend

cd backend
python -m venv venv
venv\Scripts\activate
pip install -r requirements.txt
alembic upgrade head
uvicorn app.main:app --reload

Frontend

cd frontend
npm install
npm start

The frontend dev server runs at http://localhost:4200 and proxies API calls to http://127.0.0.1:8000 through frontend/proxy.conf.json.

Environment

Create a .env file in the repository root for backend settings:

DATABASE_URL=postgresql://echoed_user:your_secure_password@localhost/echoed
STORYBOOK_PATH=./storybook
COLORINGS_PATH=./colorings
BADGES_PATH=./badges
JWT_SECRET=your_jwt_secret
FRONTEND_URL=http://localhost:4200

See CONTRIBUTING.md for full setup, seed, and test guidance.

Demo Data

To reset deterministic demo users, content, and learner states:

backend\venv\Scripts\python.exe backend\scripts\reseed_demo.py

Internal operator details live in docs/demo-readiness.md. Public-facing demo instructions live in docs/public-demo.md.

Testing

Backend:

cd backend
pytest

Frontend build:

cd frontend
cmd /c npm run build

Frontend tests:

cd frontend
cmd /c .\node_modules\.bin\ng.cmd test --watch=false --browsers=ChromeHeadless

Student demo smoke test:

cd frontend
cmd /c .\node_modules\.bin\playwright.cmd test tests/demo/student-flagship-smoke.spec.ts

Contributing

EchoEd welcomes bounded, respectful contributions. Because this project is early and has no paid budget, contribution requests should be specific and transparent.

Read:

Roadmap

The current priority is Phase 1 public open-source readiness. See ROADMAP.md for staged priorities.

Contact

License

EchoEd is licensed under the MIT License. Copyright 2025 Anthony Wright.

About

EchoEd is an interactive learning platform for African and African-American history, combining curated lessons, storytelling, timelines, gamification, achievements, and community features to make history immersive and accessible.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors