From 8eeacef62570e5164ad2e74e7149a00136d744d5 Mon Sep 17 00:00:00 2001 From: Mateus Bastos <164573233+MateuSansete@users.noreply.github.com> Date: Tue, 10 Dec 2024 22:16:16 -0300 Subject: [PATCH 1/4] Create padronizacaoIssues.md --- docs/padronizacaoIssues | 83 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 docs/padronizacaoIssues diff --git a/docs/padronizacaoIssues b/docs/padronizacaoIssues new file mode 100644 index 00000000..cc9734c4 --- /dev/null +++ b/docs/padronizacaoIssues @@ -0,0 +1,83 @@ +## 📝 Estrutura da Issue + +### **Título da Issue** +- Use um título claro e descritivo. +- Formato sugerido: + - `[BUG] Descrição curta do problema` + - `[FEATURE] Nome da funcionalidade` + - `[DOC] Atualização/Criação de documentação` + +### **Descrição** +Preencha os seguintes campos para descrever a issue: + +1. **Resumo**: + - Breve descrição da issue. + +2. **Contexto**: + - Explique o problema ou a necessidade. + - Inclua links ou referências relevantes, se houver. + +3. **Critérios de Aceitação**: + - Lista dos requisitos necessários para que a issue seja considerada resolvida. + - Exemplo: + - [ ] O botão X está funcionando conforme o esperado. + - [ ] O endpoint retorna os dados corretamente. + +4. **Tarefas**: + - Liste as etapas necessárias para completar a issue: + - [ ] Etapa 1 + - [ ] Etapa 2 + - [ ] Etapa 3 + +### **Prioridade** +Indique a prioridade da issue: +- `Alta`: Impacta diretamente o funcionamento principal do sistema. +- `Média`: Importante, mas não impede o progresso do projeto. +- `Baixa`: Melhorias ou ajustes estéticos. + +### **Anexos** +Inclua imagens, logs ou exemplos de código, se necessário. + +--- + +## 🚀 Boas Práticas + +- Mantenha as issues objetivas e claras. +- Atualize a issue à medida que houver progresso. +- Adicione etiquetas (`bug`, `feature`, `documentation`, etc.) para facilitar a categorização. +- Associe a issue a um milestone ou projeto, se aplicável. + +--- + +## Exemplo de Issue Preenchida + +### **Título:** +`[BUG] Erro ao carregar o mapa interativo` + +### **Descrição:** +1. **Resumo**: + - O mapa interativo não está carregando ao acessar a página inicial. + +2. **Contexto**: + - O problema ocorre em todas as sessões de usuário ao usar navegadores baseados em Chromium. + - Logs de erro no console indicam falha na comunicação com o endpoint `/api/map`. + +3. **Critérios de Aceitação**: + - [ ] O mapa carrega corretamente em navegadores compatíveis. + - [ ] Logs de erro são tratados adequadamente. + +4. **Tarefas**: + - [ ] Investigar o erro no endpoint `/api/map`. + - [ ] Corrigir a falha de comunicação. + - [ ] Validar o funcionamento em diferentes navegadores. + +### **Prioridade:** +Alta + +### **Anexos:** +- Captura de tela do erro no console. +- Logs detalhados do servidor. + +--- + +Seguindo este padrão, garantimos a consistência e a produtividade no gerenciamento das issues do projeto Urbanize. From 522c3c4b06308a9338c2df214cc860ac8f59851a Mon Sep 17 00:00:00 2001 From: Mateus Bastos <164573233+MateuSansete@users.noreply.github.com> Date: Tue, 10 Dec 2024 22:16:48 -0300 Subject: [PATCH 2/4] padronizacaoIssues.md --- docs/{padronizacaoIssues => padronizacaoIssues.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{padronizacaoIssues => padronizacaoIssues.md} (100%) diff --git a/docs/padronizacaoIssues b/docs/padronizacaoIssues.md similarity index 100% rename from docs/padronizacaoIssues rename to docs/padronizacaoIssues.md From 1c2f3bce139875fa435c174384f628d1596d8eb2 Mon Sep 17 00:00:00 2001 From: Mateus Bastos <164573233+MateuSansete@users.noreply.github.com> Date: Tue, 10 Dec 2024 22:36:04 -0300 Subject: [PATCH 3/4] Update padronizacaoIssues.md --- docs/padronizacaoIssues.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/padronizacaoIssues.md b/docs/padronizacaoIssues.md index cc9734c4..c1677f9f 100644 --- a/docs/padronizacaoIssues.md +++ b/docs/padronizacaoIssues.md @@ -1,7 +1,7 @@ ## 📝 Estrutura da Issue ### **Título da Issue** -- Use um título claro e descritivo. +- Use um título claro e descritivo. - Formato sugerido: - `[BUG] Descrição curta do problema` - `[FEATURE] Nome da funcionalidade` @@ -18,7 +18,7 @@ Preencha os seguintes campos para descrever a issue: - Inclua links ou referências relevantes, se houver. 3. **Critérios de Aceitação**: - - Lista dos requisitos necessários para que a issue seja considerada resolvida. + - Lista dos requisitos necessários para que a issue seja considerada resolvida. - Exemplo: - [ ] O botão X está funcionando conforme o esperado. - [ ] O endpoint retorna os dados corretamente. @@ -51,10 +51,11 @@ Inclua imagens, logs ou exemplos de código, se necessário. ## Exemplo de Issue Preenchida -### **Título:** +### **Título:** `[BUG] Erro ao carregar o mapa interativo` ### **Descrição:** + 1. **Resumo**: - O mapa interativo não está carregando ao acessar a página inicial. @@ -71,13 +72,14 @@ Inclua imagens, logs ou exemplos de código, se necessário. - [ ] Corrigir a falha de comunicação. - [ ] Validar o funcionamento em diferentes navegadores. -### **Prioridade:** +### **Prioridade:** Alta ### **Anexos:** - Captura de tela do erro no console. - Logs detalhados do servidor. + --- Seguindo este padrão, garantimos a consistência e a produtividade no gerenciamento das issues do projeto Urbanize. From 438f5c8b081e1df260035f709fc16a92b0f34af7 Mon Sep 17 00:00:00 2001 From: Bessa Date: Wed, 11 Dec 2024 16:44:14 -0300 Subject: [PATCH 4/4] =?UTF-8?q?feat:=20dockeriza=C3=A7=C3=A3o=20do=20front?= =?UTF-8?q?-end?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .dockerignore | 34 +++++++++++++++++++++++++++++++ README.Docker.md | 22 ++++++++++++++++++++ app/static/css/style.css | 0 app/views/html/index.html | 0 compose.yaml | 15 ++++++++++++++ frontend/vite-project/Dockerfile | 22 ++++++++++++++++++++ frontend/vite-project/src/App.tsx | 2 +- 7 files changed, 94 insertions(+), 1 deletion(-) create mode 100644 .dockerignore create mode 100644 README.Docker.md delete mode 100644 app/static/css/style.css delete mode 100644 app/views/html/index.html create mode 100644 compose.yaml create mode 100644 frontend/vite-project/Dockerfile diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..dc157ff1 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,34 @@ +# Include any files or directories that you don't want to be copied to your +# container here (e.g., local build artifacts, temporary files, etc.). +# +# For more help, visit the .dockerignore file reference guide at +# https://docs.docker.com/go/build-context-dockerignore/ + +**/.classpath +**/.dockerignore +**/.env +**/.git +**/.gitignore +**/.project +**/.settings +**/.toolstarget +**/.vs +**/.vscode +**/.next +**/.cache +**/*.*proj.user +**/*.dbmdl +**/*.jfm +**/charts +**/docker-compose* +**/compose.y*ml +**/Dockerfile* +**/node_modules +**/npm-debug.log +**/obj +**/secrets.dev.yaml +**/values.dev.yaml +**/build +**/dist +LICENSE +README.md diff --git a/README.Docker.md b/README.Docker.md new file mode 100644 index 00000000..8300f21d --- /dev/null +++ b/README.Docker.md @@ -0,0 +1,22 @@ +### Building and running your application + +When you're ready, start your application by running: +`docker compose up --build`. + +Your application will be available at http://localhost:5173. + +### Deploying your application to the cloud + +First, build your image, e.g.: `docker build -t myapp .`. +If your cloud uses a different CPU architecture than your development +machine (e.g., you are on a Mac M1 and your cloud provider is amd64), +you'll want to build the image for that platform, e.g.: +`docker build --platform=linux/amd64 -t myapp .`. + +Then, push it to your registry, e.g. `docker push myregistry.com/myapp`. + +Consult Docker's [getting started](https://docs.docker.com/go/get-started-sharing/) +docs for more detail on building and pushing. + +### References +* [Docker's Node.js guide](https://docs.docker.com/language/nodejs/) \ No newline at end of file diff --git a/app/static/css/style.css b/app/static/css/style.css deleted file mode 100644 index e69de29b..00000000 diff --git a/app/views/html/index.html b/app/views/html/index.html deleted file mode 100644 index e69de29b..00000000 diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 00000000..f94242b4 --- /dev/null +++ b/compose.yaml @@ -0,0 +1,15 @@ +services: + server: + build: + context: ./frontend/vite-project + environment: + NODE_ENV: production + ports: + - 5173:5173 + develop: + watch: + - path: ./frontend/vite-project/package.json + action: rebuild + - path: ./frontend/vite-project + target: /usr/src/app + action: sync diff --git a/frontend/vite-project/Dockerfile b/frontend/vite-project/Dockerfile new file mode 100644 index 00000000..5a98652f --- /dev/null +++ b/frontend/vite-project/Dockerfile @@ -0,0 +1,22 @@ +# Dockerfile + +# Use uma imagem base do Node.js +FROM node:18 + +# Defina o diretório de trabalho no contêiner +WORKDIR /usr/src/app + +# Copie os arquivos do package.json e package-lock.json +COPY package*.json ./ + +# Instale as dependências do projeto +RUN npm install + +# Copie o restante do projeto para o diretório de trabalho +COPY . . + +# Exponha a porta padrão do Vite (geralmente é 5173) +EXPOSE 5173 + +# Comando padrão para iniciar o Vite +CMD npm run dev -- --host diff --git a/frontend/vite-project/src/App.tsx b/frontend/vite-project/src/App.tsx index 3d7ded3f..40856275 100644 --- a/frontend/vite-project/src/App.tsx +++ b/frontend/vite-project/src/App.tsx @@ -26,7 +26,7 @@ function App() {

- Click on the Vite and React logos to learn more + Click on the Vite and React to learn more

)