From 6bcf6f07b5ba1dcc4597bbd6f16f439935b9cde6 Mon Sep 17 00:00:00 2001 From: Marcelo-Adrian Date: Fri, 16 Aug 2024 10:51:04 -0300 Subject: [PATCH] Docs: README do backend --- backend/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 backend/README.md diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 00000000..1ae4f204 --- /dev/null +++ b/backend/README.md @@ -0,0 +1,12 @@ +## Back-end + +Esta pasta contém toda a parte denominada *back-end* do nosso projeto. Ela inclui as seguintes subpastas: + +- **`colecao_de_dados`**: Responsável pela coleta diária de dados das licitações. +- **`extrair_dados_csv`**: Contém o script utilizado inicialmente para construir nossa base de dados. +- **`newsletter`**: Contém os scripts relacionados à manipulação de e-mails do projeto. +- **`server`**: Contém todos os scripts necessários para manter nosso banco de dados funcionando e ativo. +- **`twitter`**: Contém todos os scripts relacionados à nossa página automatizada no Twitter. +- **`package-lock`, `package` e `requirements`**: Scripts auxiliares para a instalação de certas funcionalidades. + +Em cada subpasta, há um arquivo `README.md` que explica como utilizar os scripts presentes nela.