From ceaa2ae09d63f813a1ffbb433d2f505d71afa25e Mon Sep 17 00:00:00 2001 From: gabriel Date: Mon, 2 Sep 2024 12:17:36 -0300 Subject: [PATCH] doc: alterando os paths do README e mudando o getting started --- README.md | 20 +++------ docker-compose.yml | 22 +++++----- docs/index.md | 43 +++++--------------- "docs/vis\303\243o geral/modelagem_banco.md" | 1 - "docs/vis\303\243o geral/testes.md" | 1 - 5 files changed, 28 insertions(+), 59 deletions(-) delete mode 100644 "docs/vis\303\243o geral/modelagem_banco.md" delete mode 100644 "docs/vis\303\243o geral/testes.md" diff --git a/README.md b/README.md index 9aa406d..b0b60fb 100644 --- a/README.md +++ b/README.md @@ -19,14 +19,14 @@ Através desta aplicação, buscamos oferecer uma maneira mais transparente e ac - [🤖 Identidade Visual](#-identidade-visual) - [👥 Desenvolvedores](#-desenvolvedores) - [🗒 Story Map](#-story-map) - - [🛠 Arquitetura](#-arquitetura) - - [🧪 Testes](#testes) + - [🛠 Arquitetura](https://unb-mds.github.io/2024-1-MinasDeCultura/Arquitetura/Arquitetura/) + - [🧪 Testes](https://unb-mds.github.io/2024-1-MinasDeCultura/Como%20executar/Front-end/Executar%20os%20Testes/) ## 🚀 Getting Started ### Pré-requisito -- [Docker compose](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) +- Baixar o docker compose usando o apt [Aqui](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) ### Clonar o repositório @@ -40,22 +40,14 @@ git clone https://github.com/unb-mds/2024-1-MinasDeCultura.git cd 2024-1-MinasDeCultura ``` -### Configurar o arquivo .env -O projeto depende de algumas variáveis de ambiente que precisam ser configuradas antes de iniciar os containers. No diretório backend do projeto , crie um arquivo .env com as seguintes variáveis, no caso do nosso projeto estamos usando um banco de dados no SUPABASE: +### Iniciar os containers -```bash -SUPABASE_URL= -SUPABASE_KEY= -``` - -Iniciar os containers - -Após configurar o .env, você pode iniciar o projeto executando o comando abaixo. Este comando irá construir as imagens Docker necessárias e iniciar todos os serviços definidos no docker-compose.yml: +Você pode iniciar o projeto executando o comando abaixo. Este comando irá construir as imagens Docker necessárias e iniciar todos os serviços definidos no docker-compose.yml, o parâmetro "-d" serve para a aplicação rodar em segundo plano: ```bash - docker compose up + docker compose up -d ``` ### Acessar o projeto diff --git a/docker-compose.yml b/docker-compose.yml index e26562f..6d6c238 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -9,14 +9,14 @@ services: ports: - "3000:3000" - backend: - build: - context: ./backend - dockerfile: Dockerfile - volumes: - - ./backend:/backend - - /backend/node_modules - ports: - - "5000:5000" - depends_on: - - frontend + # backend: + # build: + # context: ./backend + # dockerfile: Dockerfile + # volumes: + # - ./backend:/backend + # - /backend/node_modules + # ports: + # - "5000:5000" + # depends_on: + # - frontend diff --git a/docs/index.md b/docs/index.md index 4b698f1..b10d761 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,16 +12,16 @@ Através desta aplicação, buscamos oferecer uma maneira mais transparente e ac ## 📝 Sumário - [Minas de Cultura](#projeto-de-análise-de-licitações-culturais) - - [Sumário](#sumário) - - [Funcionalidades](#funcionalidades-previstas) - - [Tecnologias](#tecnologias) - - [Web scrapy](https://unb-mds.github.io/2024-1-MinasDeCultura/Como%20executar/Tutorial_scrapy/) - - [Identidade Visual](#identidade-visual) - - [Desenvolvedores](#desenvolvedores) - - [Story Map](https://miro.com/app/board/uXjVKYtRMq0=/?moveToWidget=3458764584482040000&cot=10) - - [Arquitetura](https://unb-mds.github.io/2024-1-MinasDeCultura/Arquitetura/Arquitetura/) - - + - [📝 Sumário](#-sumário) + - [🚀 Getting Started](#-getting-started) + - [⚙️ Funcionalidades](#%EF%B8%8F-funcionalidades-previstas) + - [💻 Tecnologias](#-tecnologias) + - [🤖 Identidade Visual](#-identidade-visual) + - [👥 Desenvolvedores](#-desenvolvedores) + - [🗒 Story Map](#-story-map) + - [🛠 Arquitetura](https://unb-mds.github.io/2024-1-MinasDeCultura/Arquitetura/Arquitetura/) + - [🧪 Testes](https://unb-mds.github.io/2024-1-MinasDeCultura/Como%20executar/Front-end/Executar%20os%20Testes/) + ## ⚙️ Funcionalidades Previstas - **Coleta de Dados:** Implementação de um raspadores utilizando as ferramentas scrapy e selenium. @@ -65,7 +65,7 @@ Através desta aplicação, buscamos oferecer uma maneira mais transparente e ac ### Pré-requisito -- [Docker compose](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) +- Baixar o docker compose usando o apt [Aqui](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) ### Clonar o repositório @@ -79,27 +79,6 @@ git clone https://github.com/unb-mds/2024-1-MinasDeCultura.git cd 2024-1-MinasDeCultura ``` -### Configurar o arquivo .env - -O projeto depende de algumas variáveis de ambiente que precisam ser configuradas antes de iniciar os containers. No diretório backend do projeto , crie um arquivo .env com as seguintes variáveis, no caso do nosso projeto estamos usando um banco de dados no SUPABASE: - -```bash -SUPABASE_URL= -SUPABASE_KEY= -``` - -Iniciar os containers - -Após configurar o .env, você pode iniciar o projeto executando o comando abaixo. Este comando irá construir as imagens Docker necessárias e iniciar todos os serviços definidos no docker-compose.yml: - -```bash - - docker compose up -``` -### Acessar o projeto - -Depois que os containers estiverem em execução, você poderá acessar o projeto em http://localhost:3000. - ## 🤖 Identidade Visual diff --git "a/docs/vis\303\243o geral/modelagem_banco.md" "b/docs/vis\303\243o geral/modelagem_banco.md" deleted file mode 100644 index d87cb26..0000000 --- "a/docs/vis\303\243o geral/modelagem_banco.md" +++ /dev/null @@ -1 +0,0 @@ -# Modelagem do banco \ No newline at end of file diff --git "a/docs/vis\303\243o geral/testes.md" "b/docs/vis\303\243o geral/testes.md" deleted file mode 100644 index e2440dd..0000000 --- "a/docs/vis\303\243o geral/testes.md" +++ /dev/null @@ -1 +0,0 @@ -# Testes frontend \ No newline at end of file