FIXME: Provide a concise overview of the project, its purpose, the problem it addresses, and its main objectives.
Table of Contents (Click to expand)
- Summary
- How to install and run
- How to use
- Features and limitations
- Examples of use
- Technical information
- Testing
- Project constraints and methodology
- Technologies Used
- Authors
- License
(Click for detailed information on prerequisites, download and installation/configuration/run steps)
FIXME: List all requirements needed to run the project, distinguishing mandatory system requirements from optional requirements needed for development, testing, or running individual components.
FIXME: Mention required software, runtimes, package managers, accounts, hardware, network access, external services, and other prerequisites.
FIXME: List additional tools or software that are useful or required for specific workflows, such as Git, a web browser, development tools, or testing dependencies.
FIXME: Explain how Docker or the main container/runtime environment can be installed when relevant.
FIXME: Provide installation instructions specific to this operating system/version.
FIXME: Provide installation and integration instructions specific to WSL/WSL 2.
FIXME: Provide installation instructions for Debian-based distributions.
FIXME: Provide installation instructions for Arch-based distributions.
FIXME: Explain the overall configuration and startup process, including how configuration is provided and where configuration files are expected.
FIXME: Explain how to clone, download, or otherwise obtain the project files.
FIXME: Explain how to create and configure the project's environment/configuration file(s).
FIXME: Clearly identify secrets, passwords, API keys, tokens, URLs, or other values that must be changed before running the project.
FIXME: Explain how users should generate secure values where applicable.
FIXME: Document available database initialization/seeding modes, their purpose, defaults, and configuration variables.
FIXME: Explain how to switch between initialization/seeding modes and whether existing persistent data must be removed first.
FIXME: Explain the commands and procedures that can be repeatedly used to manage the application after initial configuration.
FIXME: Explain how to start/build the complete application stack.
FIXME: Document the recommended/simple startup method, such as a project-provided script.
FIXME: Document the manual commands for users who need more control over the build or startup process.
FIXME: Explain relevant command-line options and their effects.
FIXME: Explain how to inspect service status, logs, resource usage, health, and other runtime information.
FIXME: Explain how to stop the application while preserving persistent data.
FIXME: Explain how to completely remove containers, volumes, generated data, downloaded models, or other persistent resources.
FIXME: Clearly warn the user about irreversible data loss.
FIXME: Provide the shortest practical instructions for starting and stopping the application once all installation and configuration steps have been completed.
FIXME: Document default access URLs, ports, credentials, or other information needed to access the running application.
FIXME: Explain the main user workflows and how the major application components are used.
FIXME: Describe the interaction between the main user-facing interfaces/components.
Client UI sneak peek
FIXME: Optionally provide screenshots or other visual examples of the main user interface.
Backoffice UI sneak peek
FIXME: Describe any important user-interface-specific behavior, restrictions, or workflows.
FIXME: Briefly explain the overall scope of the project and whether the current version should be considered a proof-of-concept, prototype, MVP, production-ready system, etc.
FIXME: Provide a high-level list of the features available in the current release.
FIXME: Describe inventory, catalog, branch, stock, CRUD, validation, synchronization, or other core business functionality.
FIXME: Describe real-time update mechanisms, event propagation, affected interfaces, and any relevant implementation details.
FIXME: Describe authentication, authorization, roles, permissions, session/token handling, and inter-service security.
FIXME: Describe AI-assisted functionality, supported interactions, MCP tools/resources, model/provider support, and how AI interacts with application data.
FIXME: Describe containerization, orchestration, portability, persistence, deployment characteristics, and relevant infrastructure features.
FIXME: Explain the project's current limitations and deliberate trade-offs.
FIXME: Document limitations related to AI behavior, context/memory, supported languages, model quality, tool calling, data enrichment, latency, or provider-specific behavior.
FIXME: Document architectural limitations such as scaling constraints, single-node assumptions, resource requirements, or infrastructure dependencies.
FIXME: Document known security limitations, missing hardening, missing audits, network-security concerns, rate limiting, CORS, authentication limitations, or other production-readiness concerns.
FIXME: Document missing automated tests, incomplete coverage, unsupported testing layers, and known testing limitations.
(Click to expand)
FIXME: Provide representative successful use cases demonstrating the main capabilities of the application.
FIXME: Provide examples of queries/inputs using the most common identifiers and, where relevant, different supported languages.
FIXME: Show representative expected outputs.
FIXME: Provide examples involving stock availability, branches, quantities, or inventory aggregation.
FIXME: Show representative expected outputs.
FIXME: Provide examples combining multiple supported capabilities in a single request.
FIXME: Provide representative unsupported, invalid, ambiguous, or out-of-scope requests.
FIXME: Explain the expected failure/refusal/error behavior.
FIXME: State the intended scope of this section and link to a deeper architecture/technical document if one exists.
FIXME: Provide a high-level description of the system architecture and the responsibilities of its major components.
FIXME: Explain the architectural principles, design decisions, separation of concerns, security boundaries, maintainability goals, or other principles guiding the implementation.
FIXME: Describe the main application components, services, modules, packages, or layers and their respective responsibilities.
FIXME: Summarize the main programming languages, frameworks, libraries, databases, infrastructure, and external services used to implement the project.
FIXME: Describe how the major components communicate with each other, including protocols, APIs, authentication mechanisms, data formats, and relevant communication constraints.
FIXME: Replace this with a high-level architecture/communication diagram if useful.
Backoffice...
FIXME: Describe the internal-user flow, including authentication, interface actions, API calls, business operations, and responses.
Frontoffice
FIXME: Describe the anonymous/end-user flow, including input handling, communication with backend/AI services, context retrieval, and response generation.
FIXME: Provide a high-level architecture diagram showing the major components and their relationships.
FIXME give hindsight on how much memory is expected to be consumed, with example metrics if possible.
FIXME make short summary, delegate to TESTING.md
This project has been realized in compliance with all business specifications and technical constraints detailed in the Project context
Confer PROJECT.md
FIXME short summary explaining how we worked (branching, planning, reviews etc)
FIXME put listing of "badges" for technos.
FIXME list authors with links to githubs
FIXME license