Skip to content

vietfood/cs4all

Repository files navigation

cs4all-vn

cs4all-vn is a dynamic web application and Vietnamese CS learning platform featuring educational content — Vietnamese translations and explanations of computer science textbooks like PRML and Sutton & Barto's Reinforcement Learning.

cs4all-vn is a trademark of Nguyen.

Architecture

  • Frontend: Astro (SSR Mode) + React + Tailwind CSS + Shadcn/UI. Located in cs4all-frontend/.
  • Content Engine: Custom Astro loader fetching MDX from a remote GitHub repository (vietfood/cs4all-content).
  • Backend & Database: Supabase (PostgreSQL & Native Auth) + FastAPI (AI Inference, task queue, and Grading engine). Located in cs4all-backend/.
  • Core ML Service: Langchain (orchestrating commercial LLM APIs).

Features

  • Interactive Curriculum: MDX-based curriculum with built-in exercises, questions, and solutions.
  • Auth and Progress Tracking: Keep track of read lessons and exercise completion utilizing Supabase.
  • LLM-Assisted Grading: Background worker via FastAPI evaluates exercise submissions via Langchain before submitting them for human review.
  • Socratic Tutoring/Hints: Streaming LLM hints using a side-by-side DeepWiki-inspired reference panel, anchoring AI responses to exact lesson text.

Development Guide

This is a monorepo-style project designed to be heavily supported by LLM agents. Every contributor, including AI agents, must read the documentation before undertaking tasks.

  1. docs/AGENTS.mdMaster Orchestration File. (Must be read first). Outlines cross-repo rules, current development phases, and shared contracts.
  2. docs/DEVELOPMENT.md — Explains the project rationale, phases, and feature history.
  3. docs/ARCHITECTURE.md — Diagrams and deep-dives into application structure.
  4. docs/DATABASE.md — Database design, row level security, and schema interactions.
  5. cs4all-frontend/AGENTS.md — Frontend-specific technical rules.
  6. cs4all-backend/AGENTS.md — Backend-specific technical rules.

Important: This platform serves content hosted strictly under vietfood/cs4all-content. AI agents are prohibited from making direct edits to the content repository.

Licensing

  • Code License: This project's code is strictly licensed under the AGPL-3.0 License.
  • Content License: Educational content fetched by this site is licensed under CC BY-SA 4.0.

See the LICENSE and NOTICE files for details.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors