diff --git a/README.md b/README.md index a914176..cca30c8 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,8 @@ The system is split into two autonomous components that communicate via shared f ### Quick Start 1. **Clone the repository**: ```bash - git clone https://github.com/imxade/dont-compete.git - cd dont-compete + git clone https://github.com/AOSSIE-Org/LibrEd.git +cd LibrEd ``` 2. **Launch the System**: @@ -51,7 +51,7 @@ The system is split into two autonomous components that communicate via shared f 3. **Monitor Pipeline**: ```bash - docker compose logs -f generator + asset-generator ``` ### Configuration @@ -91,6 +91,16 @@ docker run --rm --network gatebuster_app_network \ mcr.microsoft.com/playwright:v1.58.0-jammy \ /bin/sh -c "npm install && npx playwright test" ``` +On Windows PowerShell, use: + +```powershell +docker run --rm --network gatebuster_app_network ` +-e BASE_URL=http://frontend:3000 ` +-v ${PWD}/frontend:/app ` +-w /app ` +mcr.microsoft.com/playwright:v1.58.0-jammy ` +sh -c "npm install && npx playwright test" +``` *Note: Ensure the frontend service is running (`docker compose up`) before starting Playwright tests.* ## License diff --git a/generator/src/config.py b/generator/src/config.py index 63946f3..9350bbc 100644 --- a/generator/src/config.py +++ b/generator/src/config.py @@ -1,3 +1,18 @@ +""" +config.py + +Central configuration file for the LibrEd asset generator. + +This module defines environment variables and default configuration +values used across the generator pipeline, including: + +- Ollama model configuration +- Local LLM server settings +- Asset directories and processing parameters + +The configuration is designed to support the project's +100% local and containerized architecture. +""" import os # Environment Configuration