Merge pull request #163 from unb-mds/readme

adicionando os readme's das pastas do frontend

README.md

@@ -186,13 +186,17 @@ python manage.py test
 
 ### Frontend
 
-1. Navegue até o diretório `frontend` e instale as dependências:
+ 1. Clone o repositório
+    ```bash
+    git clone https://github.com/unb-mds/LicitaBSB-24.1.git
+    ```
+2. Navegue até o diretório `frontend` e instale as dependências:
 
     ```bash
     npm install
     ```
 
-2. Para rodar o projeto, execute:
+3. Para rodar o projeto, execute:
 
     ```bash
     npm run build
@@ -220,7 +224,7 @@ cd LicitaBSB-24.1/frontend
 ```
 > Instale as dependências
 ```bash
-npm i
+npm install
 ```
 
 3. Estrutura dos Testes

frontend/README.md

@@ -6,3 +6,14 @@ Currently, two official plugins are available:
 
 - [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
 - [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Front-end
+
+Esta pasta contém toda a parte denominada *front-end* do nosso projeto. Ela inclui as seguintes subpastas:
+
+- **`assets`**: Contém imagens e outros documentos do front estão.
+- **`coverage`**: Contém o código que faz o coverage do front.
+- **`public`**: Contém algumas outras informações necessários do front end. 
+- **`src`**: Contém todos os arquivos de código do front end.
+
+Em cada subpasta, há um arquivo `README.md` que explica como utilizar os scripts presentes nela.

frontend/assets/README.md

@@ -0,0 +1,9 @@
+## assets
+
+Esta pasta contém toda a parte denominada *assets* do nosso projeto. Ela inclui as seguintes subpastas:
+
+- **`articles`**: Contém as imagens usadas nas páginas dos artigos.
+- **`carrosel`**: Contém as imagens usadas no carrosel.
+- **`members`**: Contém as fotos dos membros do grupo. 
+
+Em cada subpasta, há um arquivo `README.md` que explica como utilizar os scripts presentes nela.

frontend/coverage/README.md

@@ -0,0 +1,7 @@
+## coverage
+
+Esta pasta contém toda a parte denominada *coverage* do nosso projeto. Ela inclui as seguintes subpastas:
+
+- **`lcov-report`**: Contém o relatório dos testes executados.
+
+Em cada subpasta, há um arquivo `README.md` que explica como utilizar os scripts presentes nela.

frontend/public/README.md

@@ -0,0 +1,7 @@
+## public
+
+Esta pasta contém toda a parte denominada *public* do nosso projeto. Ela inclui as seguintes subpastas:
+
+- **`images`**: Contém a imagem do dashboard
+
+Em cada subpasta, há um arquivo `README.md` que explica como utilizar os scripts presentes nela.

frontend/src/README.md

@@ -0,0 +1,14 @@
+## src
+
+Esta pasta contém toda a parte denominada *src* do nosso projeto. Ela inclui as seguintes subpastas:
+
+- **`components`**: Contém componentes que são utilizados diversar vezes no código do front-end.
+- **`config`**: Contém a configuração da api com o front-end.
+- **`hooks`**: Contém o código para realizar a busca dentro do site. 
+- **`mocks`**: Contém algumas páginas que são redirecionadas atraves do carrosel.
+- **`pages`**: Contém as páginas do front-end do site.
+- **`services`**: Contém os código que puxam os dados da api.
+- **`styles`**: Contém o estilo base do site.
+- **`utils`**: Contém utilitarios para juntar com a api.
+
+Em cada subpasta, há um arquivo `README.md` que explica como utilizar os scripts presentes nela.