@igoruehara/canvas-flow 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Canvas Flow contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,152 @@
+# Canvas Flow
+
+Canvas Flow roda frontend e backend juntos a partir de um pacote npm.
+
+## Requisitos
+
+- Node.js 20+
+- Docker Desktop opcional, apenas para subir Mongo/Milvus localmente
+
+## Rodar com Docker
+
+Este caminho sobe MongoDB local automaticamente e abre o navegador.
+
+```bash
+npx canvas-flow@latest --with-docker --open
+```
+
+Para RAG local com Milvus, MinIO e etcd:
+
+```bash
+npx canvas-flow@latest infra up --full
+npx canvas-flow@latest --open
+```
+
+Comandos uteis:
+
+```bash
+npx canvas-flow@latest infra status
+npx canvas-flow@latest infra logs
+npx canvas-flow@latest infra down
+```
+
+`infra down` para os containers, mas mantem os volumes Docker.
+
+## Rodar sem Docker
+
+Use este caminho quando voce ja tem MongoDB local, Atlas ou outro Mongo remoto.
+
+```bash
+npx canvas-flow@latest --open
+```
+
+Mongo local padrao:
+
+```txt
+mongodb://127.0.0.1:27017/canvas_flow
+```
+
+Para usar outro Mongo, edite a config:
+
+```bash
+npx canvas-flow@latest config --edit
+```
+
+```json
+{
+  "database": {
+    "mongoUrl": "mongodb+srv://usuario:senha@cluster.mongodb.net/canvas_flow?retryWrites=true&w=majority"
+  }
+}
+```
+
+## Configurar
+
+A primeira execucao cria um arquivo privado:
+
+```txt
+~/.canvas-flow/config.json
+```
+
+No Windows:
+
+```txt
+C:\Users\<usuario>\.canvas-flow\config.json
+```
+
+Abrir a config:
+
+```bash
+npx canvas-flow@latest config --edit
+```
+
+Ver o caminho da config:
+
+```bash
+npx canvas-flow@latest config
+```
+
+Exemplo com OpenAI:
+
+```json
+{
+  "providers": {
+    "openai": {
+      "apiKey": "sk-..."
+    }
+  }
+}
+```
+
+Exemplo com porta customizada:
+
+```json
+{
+  "server": {
+    "port": 3334,
+    "publicUrl": "http://localhost:3334"
+  }
+}
+```
+
+Tambem da para usar outro arquivo:
+
+```bash
+npx canvas-flow@latest --config C:\canvas-flow\config.json --open
+```
+
+Nao publique `config.json`: ele contem tokens e secrets gerados.
+
+## Validar
+
+```bash
+npx canvas-flow@latest doctor
+```
+
+Sem checar rede/Mongo:
+
+```bash
+npx canvas-flow@latest doctor --offline
+```
+
+## Instalar globalmente
+
+Opcional:
+
+```bash
+npm i -g canvas-flow
+canvas-flow --with-docker --open
+```
+
+## Mantenedores
+
+O pacote e gerado a partir dos apps reais:
+
+```bash
+cd npm_canvas_flow
+npm run bundle
+npm run pack:local
+```
+
+`npm run bundle` builda `frontend/`, builda `backend/` e copia os artefatos para
+`npm_canvas_flow/public` e `npm_canvas_flow/server`.