Skip to main content

GUIDEBOOK OF THE REALM

The Grand Navigation: A Valor's Guide to the Website's Byways​

Hark, travelers! I, Valor, guardian of the Bifrost and keeper of knowledge, shall guide you through the intricate pathways of this website's navigation. Fear not, for even the most labyrinthine menu shall yield its secrets to my all-seeing eyes!

The NavBarMenu: A Portal to All Realms​

The heart of our journey lies within the NavbarMenu component, a majestic structure built with the sturdy blocks of React Bootstrap. It is here that we find the gateways to all the wonders and treasures this website holds.

Products: A Showcase of Innovation​

Like a bustling marketplace, the "Products" dropdown presents a dazzling array of creations:

  • ThorAPI™: The mighty code generator, forging full-stack applications with the power of the gods!
  • Valor IDE™: The agentic coding IDE, a sanctuary for developers seeking to craft elegant code with the assistance of intelligent agents.
  • ValkyrAI™: The API-native AI workflows, weaving together the threads of artificial intelligence to create seamless and powerful experiences. (Coming Soon!)
  • OpenXLS: The open-source spreadsheet SDK, a treasure trove for those who seek to manipulate and analyze data with unparalleled freedom.

Resources: A Font of Knowledge and Inspiration​

The "Resources" dropdown offers sustenance for the mind and spirit:

  • Valkyr Labs Docs: The sacred scrolls of knowledge, containing the wisdom and guidance needed to master our products and services.
  • Valkyr Labs Blog: The town crier's bulletin, filled with the latest news, insights, and pronouncements from the realm of AI and code generation.
  • Valkyr Labs GitHub: The forge of open-source innovation, where developers collaborate and contribute to the ever-expanding ecosystem of Valkyr Labs.

Authentication: Gateways to the Inner Sanctum​

For those who seek to delve deeper into the realm, the "Authentication" section provides the keys:

  • Signup: The path for new adventurers to join our ranks and embark on their own quests.
  • Login: The portal for seasoned travelers to return to their familiar haunts and continue their journeys.

Cart: A Repository of Treasures​

The "Cart" icon beckons those who have gathered valuable wares and seek to complete their transactions.

Theme Toggle: A Shift in Perspective​

Finally, the "Theme Toggle" allows travelers to adjust the lighting to their preference, ensuring a comfortable and visually pleasing experience.

The Lay of the Land: A Directory Listing of the ValkyrAI Project​

Now, let us embark on a journey through the very structure of the ValkyrAI project itself! Like exploring the winding streets of a grand city, understanding the project's directory structure is key to navigating its inner workings.

Here's a glimpse of the landscape:

  • .valoriderules: The sacred edicts that govern the development of this project, ensuring consistency and quality in all that we create.
  • docker/: The harbor where our project sets sail, containing the configurations for building and deploying our applications in the vast ocean of the cloud.
  • docs/: The library of knowledge, where we store the wisdom and insights gained throughout our development journey.
  • gridheim/: A mysterious enclave, perhaps a separate project or module, shrouded in its own secrets and lore.
  • thorapi/: The workshop of the API forges, where the tools and components for generating powerful APIs are crafted with precision and care.
  • valkyrai/: The heart of the ValkyrAI project, where the core logic and functionality reside, beating with the rhythm of innovation.
  • web/: The gateway to the user experience, where the frontend code brings our creations to life in the form of interactive websites and applications.
  • web/typescript/valkyr_labs_com/: The heart of the website, where the code for the Valkyr Labs website resides, a testament to our commitment to quality and innovation.
  • web/typescript/valkyr_labs_com/src/components/: The building blocks of the user interface, where reusable React components are meticulously crafted to create a seamless and engaging experience.
  • ValorIDE_docs/: The chronicles of Valor IDE, documenting the evolution and inner workings of our agentic coding companion.

Each of these directories holds its own treasures and secrets, waiting to be discovered by intrepid explorers. May this map guide you on your own journey of discovery!

The Scroll of Truth: Unveiling the README.md​

Now, let us turn our attention to the README.md file, a scroll of truth that reveals the inner workings and best practices of the ValkyrAI project. Within its ancient script, we find guidance on:

  • ValkyrAI: The API-Native Agentic Services Engine: A powerful platform that harnesses the power of AI to streamline and automate business processes. Built upon the mighty ThorAPI, it accelerates the creation of secure and efficient APIs, transforming OpenAPI specifications into fully functional codebases.
  • The Pillars of ValkyrAI:
    • Java Data Model Generation: Crafting comprehensive Java data models, annotated for Spring Boot and JPA, ensuring seamless integration with backend services.
    • TypeScript Client Generation: Forging fully-typed TypeScript object models and REST clients, empowering frontend applications with reliable and consistent API interactions.
    • Spring Boot Service Generation: Generating robust Spring Boot services, complete with CRUD operations and JPA integration, accelerating backend development.
    • Database Connectivity: Connecting to various relational databases via JPA, with support for multiple database platforms.
    • REST API Documentation: Integrating with SpringDoc OpenAPI to automatically generate interactive API documentation.
    • SecureField Encryption: Securing sensitive data with field-level encryption, protecting information both at rest and in transit.
    • Automatic Relationship Serialization: Seamlessly handling one-to-many and many-to-many relationships, simplifying data modeling and serialization.
    • Secure React/TypeScript Component Libraries: Generating secure, data-bound React components to build robust frontend interfaces with ease.
    • Professional Documentation Site: Generating all your API and model object documentation inline to a professional and dynamic documentation site powered by Docusaurus.
  • ExecModules: The Connectors of Power: ValkyrAI includes a growing set of pluggable ExecModules (connectors) that you can attach to workflow Tasks, such as email and payments.
  • Query By Example (QBE): ValkyrAI supports Query By Example across generated model endpoints and UI tables, allowing for flexible and powerful data filtering.
  • ThorAPI: The Foundation of Strength: ValkyrAI is built upon ThorAPI, an opinionated code generator designed for creating secure, performant, and efficient APIs.
  • The Sacred Art of Versioning: APIs, SDKs, and code libraries require versioning information to allow for changes and updates without breaking production systems.
  • The Monorepo Structure: ValkyrAI follows a Java Maven Project Monorepo structure, with a TypeScript + React web app, generated TypeScript client code, generated Spring Boot web app, a pre-configured MindsDB Docker container, and a command-line runner.
  • The OpenAPI Spec Enhancement Ritual: ThorAPI enhances your spec with CRUD Rest Endpoints and detailed Schema Components, ensuring a consistent and well-defined API.
  • SecureField: The Shield Against the Darkness: SecureField is a powerful encryption mechanism that ensures sensitive data is protected both at rest and in memory. Remember to guard your THORAPI_SECRET_KEY with your life, for without it, your data shall be lost to the void!
  • The Forbidden Auto-Generated Fields: Do not include auto-generated fields like id, modified_date, and created_date in your OpenAPI specification, lest you incur the wrath of the code gods!
  • The Council of Reserved Words: Avoid using reserved words as identifiers in your OpenAPI specification, for they are the domain of the system and shall not be trifled with!
  • The Code of Naming and Best Practices: Follow the code of naming conventions and best practices to ensure smooth code generation and maintenance, lest your code become a tangled mess of spaghetti!
  • The Trials of Troubleshooting: The README.md includes a troubleshooting section with common issues and resolutions, a guide for navigating the treacherous paths of development.
  • SecureKMS: The Key to Secure Data: ValkyrAI includes a built-in SecureField key management system, ensuring the safety and integrity of your encrypted data.
  • Valor: The All-Seeing Advisor: Valor consists of a supervisor/advisor LLM which may consist of one or more aggregated LLM services, providing guidance and insights throughout the development process.
  • VIDAR: The Guardian of Secrets: Vidar is a data encryption utility that is used to zip up and encrypt file system data and create a self-extracting encrypted jar file, protecting your data from prying eyes.
  • ./vai: The Command-Line Companion: The vai command is a simple bash script that gives developers an easy way to run the ValkyrAI generator, manage and deploy the front and backend artifacts, generate necessary encryption keys, run the vidar script and more, a trusty tool for any adventurer.
  • The OpenAI Credentials & Fallback: This project supports calling OpenAI-compatible chat completions from two paths: Controller path and Workflow path.

With this knowledge, you are now equipped to navigate the website with confidence and ease. May your journey be filled with wonder and discovery!

- Valor, Guardian of the Bifrost