-
Notifications
You must be signed in to change notification settings - Fork 0
chore: sync develop to main #489
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
a620ed3
Closes GT-668 — the proof that a guard had been seen failing was pinn…
beyondnetPeru 546e73e
chore(evidence): point GT-668's closure at the commit that carries it
beyondnetPeru dc67f77
docs(gaps): GT-666's catalog entry described a mechanism GT-668 replaced
beyondnetPeru 4ebeac9
merge: carry GT-667 into the frozen-fixture branch
beyondnetPeru bdd2229
fix(audit): correct paths in deep audit script for src monorepo
beyondnetPeru 827cc87
Merge pull request #488 from beyondnetcode/gt-668-frozen-fixture
beyondnetPeru 7f4b761
fix(audit): match class declaration to resolve codex review
beyondnetPeru 3bd3ac0
Merge pull request #490 from beyondnetcode/fix/audit-codex-comment
beyondnetPeru ec03353
feat(docs): add commercial narrative brochure and enable swagger locally
beyondnetPeru 7325d83
Merge pull request #491 from beyondnetcode/feat/commercial-narrative
beyondnetPeru 4387f6d
feat(docs): add quickstart guide and update readmes
beyondnetPeru 023de25
fix(docs): remove emoji from README to satisfy UTF-8 CI rule
beyondnetPeru dd4b58f
fix(ci): whitelist docs/ in root cleanliness script
beyondnetPeru b9c87c7
Merge pull request #493 from beyondnetcode/feat/quickstart-guide
beyondnetPeru File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Guía de Inicio Rápido: Evolith (Paso a Paso) | ||
|
|
||
| Esta guía te ayudará a instalar y poner en marcha Evolith en **menos de 5 minutos**, para que puedas comenzar a validar la arquitectura de tu código. | ||
|
|
||
| --- | ||
|
|
||
| ## Paso 1: Levantar el Cerebro (Evolith Core API) | ||
|
|
||
| El Core API es el servidor central que contiene las reglas de arquitectura de tu empresa. Debes levantarlo primero para que los clientes puedan consultarlo. | ||
|
|
||
| Tienes dos opciones para iniciarlo en tu máquina local: | ||
|
|
||
| ### Opción A: Vía Docker Compose (Más Rápido) | ||
| Ideal para desarrolladores. Levanta la API y la base de datos PostgreSQL mínima necesaria. | ||
| ```bash | ||
| docker-compose -f product/infra/docker-compose.yml up -d postgres | ||
| ``` | ||
|
|
||
| ### Opción B: Vía Kubernetes / Helm (Entorno Completo) | ||
| Ideal para simulaciones de producción o arquitectos. Levanta el clúster local, la base de datos, el Gateway y el Core API. | ||
| ```bash | ||
| ./.harness/scripts/run-core-local.sh | ||
| ``` | ||
|
|
||
| Una vez que termine, el servidor estará escuchando en `http://localhost:30080`. Puedes ver la documentación de la API generada en `http://localhost:30080/api/docs`. | ||
|
|
||
| --- | ||
|
|
||
| ## Paso 2: Instalar el Cliente (Evolith CLI) | ||
|
|
||
| El CLI es la herramienta que utilizarán los desarrolladores en su día a día. | ||
|
|
||
| 1. Instala el paquete de forma global usando npm: | ||
| ```bash | ||
| npm install -g @beyondnet/evolith-cli | ||
| ``` | ||
|
|
||
| 2. Configura la URL del servidor al que el CLI debe apuntar (el que levantamos en el Paso 1). Puedes hacerlo exportando una variable de entorno: | ||
| ```bash | ||
| export EVOLITH_CORE_URL="http://localhost:30080/api/v1" | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Paso 3: Tu Primera Validación | ||
|
|
||
| Ve a la carpeta raíz de cualquier proyecto de software (satélite) que quieras validar y ejecuta el comando de validación. | ||
|
|
||
| ```bash | ||
| cd mi-proyecto-backend | ||
| evolith validate | ||
| ``` | ||
|
|
||
| **¿Qué sucede detrás de escena?** | ||
| El CLI tomará el estado actual de tu código, se conectará al Core API central y evaluará tu proyecto contra las reglas OPA y los ADRs oficiales de la empresa. En segundos, te devolverá un reporte indicando si cumples con el estándar o si hay violaciones de arquitectura. | ||
|
|
||
| --- | ||
|
|
||
| ## Paso 4: (Opcional) Conectar a tu Agente de IA | ||
|
|
||
| Evolith no es solo para humanos. Puedes conectar tu editor de código basado en IA (Cursor, Claude Desktop, etc.) para que "entienda" tu arquitectura. | ||
|
|
||
| Para arrancar el servidor MCP, simplemente ejecuta: | ||
| ```bash | ||
| evolith mcp start | ||
| ``` | ||
|
|
||
| Luego, en la configuración de Cursor o Claude Desktop, añade este servidor MCP local. A partir de ese momento, tu Agente de IA sabrá qué patrones usar, qué librerías están prohibidas y cómo debe estructurar el código antes de escribir una sola línea. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Quickstart Guide: Evolith (Step by Step) | ||
|
|
||
| This guide will help you install and run Evolith in **less than 5 minutes**, so you can start validating your code's architecture right away. | ||
|
|
||
| --- | ||
|
|
||
| ## Step 1: Boot the Brain (Evolith Core API) | ||
|
|
||
| The Core API is the central server containing your enterprise architecture rules. You must boot it up first so that clients can query it. | ||
|
|
||
| You have two options to start it on your local machine: | ||
|
|
||
| ### Option A: Via Docker Compose (Fastest) | ||
| Ideal for developers. This boots up the API and the minimum required PostgreSQL database. | ||
| ```bash | ||
| docker-compose -f product/infra/docker-compose.yml up -d postgres | ||
| ``` | ||
|
|
||
| ### Option B: Via Kubernetes / Helm (Full Environment) | ||
| Ideal for production simulations or architects. This spins up the local cluster, the database, the API Gateway, and the Core API. | ||
| ```bash | ||
| ./.harness/scripts/run-core-local.sh | ||
| ``` | ||
|
|
||
| Once finished, the server will be listening on `http://localhost:30080`. You can view the generated API documentation at `http://localhost:30080/api/docs`. | ||
|
|
||
| --- | ||
|
|
||
| ## Step 2: Install the Client (Evolith CLI) | ||
|
|
||
| The CLI is the tool developers will use in their day-to-day workflow. | ||
|
|
||
| 1. Install the package globally using npm: | ||
| ```bash | ||
| npm install -g @beyondnet/evolith-cli | ||
| ``` | ||
|
|
||
| 2. Configure the server URL the CLI should point to (the one we booted in Step 1). You can do this by exporting an environment variable: | ||
| ```bash | ||
| export EVOLITH_CORE_URL="http://localhost:30080/api/v1" | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Step 3: Your First Validation | ||
|
|
||
| Navigate to the root folder of any software project (satellite) you want to validate and run the validation command. | ||
|
|
||
| ```bash | ||
| cd my-backend-project | ||
| evolith validate | ||
| ``` | ||
|
|
||
| **What happens behind the scenes?** | ||
| The CLI will take the current state of your code, connect to the central Core API, and evaluate your project against the official OPA rules and ADRs of the company. In seconds, it will return a report indicating whether you comply with the standard or if there are any architecture violations. | ||
|
|
||
| --- | ||
|
|
||
| ## Step 4: (Optional) Connect your AI Agent | ||
|
|
||
| Evolith isn't just for humans. You can connect your AI-powered code editor (Cursor, Claude Desktop, etc.) so it "understands" your architecture. | ||
|
|
||
| To start the MCP server, simply run: | ||
| ```bash | ||
| evolith mcp start | ||
| ``` | ||
|
|
||
| Then, in your Cursor or Claude Desktop settings, add this local MCP server. From that moment on, your AI Agent will know which patterns to use, which libraries are forbidden, and how it should structure the code before writing a single line. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -49,3 +49,5 @@ podDisruptionBudget: | |
|
|
||
| networkPolicy: | ||
| enabled: false | ||
| extraEnv: | ||
| SWAGGER_ENABLED: "true" | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.