For Developers

For Developers #

LAMB is an Open Source Project #

LAMB is an open source project developed under GPL v3 license. We’re on GitHub and we greatly appreciate community collaborations and contributions.

๐Ÿ”— View on GitHub

๐Ÿค Contributions #

We appreciate all types of contributions:

  • Pull Requests with new features or improvements
  • Bug fixes and reported issues
  • Documentation and translations
  • Testing and issue reporting
  • Ideas and improvement suggestions

๐Ÿ“š Technical Documentation #

We maintain complete and updated documentation for developers:

System Architecture #

Complete document on LAMB architecture, including:

  • System components
  • Data architecture
  • Completion pipeline
  • Plugin architecture
  • Frontend and backend architecture
๐Ÿ“– View Architecture Documentation

Product Requirements Document (PRD) #

Product requirements document with:

  • Functional specifications
  • Use cases
  • Workflows
  • Technical requirements
๐Ÿ“‹ View Product Requirements Document (PRD)

๐Ÿ› ๏ธ Tech Stack #

  • Backend: FastAPI (Python 3.11+)
  • Frontend: Svelte 5, SvelteKit
  • Database: SQLite
  • Vector Store: ChromaDB
  • Containerization: Docker, Docker Compose

๐Ÿš€ Getting Started with Development #

  1. Clone the repository:

    1
    2
    
    git clone https://github.com/Lamb-Project/lamb.git
    cd lamb
    
  2. Set up environment:

    1
    2
    
    export LAMB_PROJECT_PATH=$(pwd)
    docker-compose up -d
    
  3. Access services:

    • Frontend: http://localhost:5173
    • Backend: http://localhost:9099
    • Open WebUI: http://localhost:8080

๐Ÿ’ฌ Community #

  • GitHub Issues: To report bugs or request features
  • GitHub Discussions: For questions and discussions
  • Pull Requests: Welcome with improvements and new features

๐Ÿ“– Academic Publication #

If you use LAMB in your research, please cite our work:

“LAMB: An open-source software framework to create artificial intelligence assistants deployed and integrated into learning management systems”

  • Authors: Marc Alier, Juanan Pereira, Francisco Josรฉ Garcรญa-Peรฑalvo, Maria Jose Casaรฑ, Jose Cabrรฉ
  • Journal: Computer Standards & Interfaces, Volume 92, March 2025
  • DOI: 10.1016/j.csi.2024.103940

Join us on GitHub and help make LAMB a better platform for education!

๐ŸŒŸ Star on GitHub