You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/pedrobiqua/Search_Engine/actions/workflows/cmake-multi-platform.yml)
[](https://github.com/pedrobiqua/Search_Engine/actions/workflows/cmake-multi-platform.yml)
Este projeto é um motor de busca simples que utiliza páginas da Wikipedia. Ele constrói um índice reverso para buscar palavras-chave e utiliza o algoritmo PageRank para ranquear as páginas com base na relevância e nos links entre elas.
9
-
10
-
## Requisitos
11
-
12
-
Antes de compilar o projeto, certifique-se de que seu ambiente atenda aos seguintes requisitos:
13
-
14
-
- CMake 3.10 ou superior
15
-
- Google Test para testes unitários
16
-
- Um compilador compatível com C++11 ou superior
17
-
18
-
## Estrutura do Projeto
19
-
20
-
-**src/**: Implementação principal do motor de busca, incluindo o índice reverso e o PageRank.
21
-
-**tests/**: Testes unitários para verificar a funcionalidade do sistema.
22
-
-**CMakeLists.txt**: Arquivo de configuração para construir o projeto com CMake.
23
-
24
-
## Compilando o Projeto
25
-
26
-
Para compilar o projeto, siga os seguintes passos:
27
-
28
-
1. Crie um diretório `build` e entre nele:
29
-
30
-
```bash
31
-
mkdir build &&cd build
32
-
```
33
-
34
-
2. Execute o CMake para gerar os arquivos de compilação:
35
-
36
-
```bash
37
-
cmake ..
38
-
```
39
-
40
-
3. Compile o projeto utilizando `make`:
41
-
42
-
```bash
43
-
make
44
-
```
45
-
46
-
## Executando os Testes
47
-
48
-
Como este projeto é uma biblioteca, você pode rodar os testes unitários para verificar a funcionalidade.
49
-
50
-
1. Após a compilação, no diretório `build`, execute o comando:
51
-
52
-
```bash
53
-
./tests/unit-tests/LibUnitTests
54
-
```
7
+
**Search Engine** is a simple, efficient engine that builds a reverse index for keyword searching and ranks results using the **PageRank** algorithm.
55
8
56
-
Isso executará os testes que cobrem o funcionamento da engine, indexação reversa e PageRank.
9
+
## 📋 Requirements
57
10
58
-
## Funcionamento
11
+
Before compiling the project, ensure your environment meets the following requirements:
59
12
60
-
- **Indexação Reversa**: Mapeia palavras-chave para as páginas da Wikipedia onde aparecem.
61
-
- **PageRank**: Algoritmo que atribui uma pontuação de relevância a cada página baseada nos links e na estrutura da Wikipedia.
62
-
- **Consulta**: Busca páginas relacionadas a uma palavra-chave e ordena os resultados com base no PageRank.
13
+
-**CMake 3.10** or higher
14
+
-**Google Test** for unit testing
15
+
-A **C++11** compatible compiler or higher
63
16
64
-
## Licença
17
+
## 📂 Project Structure
65
18
66
-
Ainda estamos avaliando qual lincença será a lincença que será utilizada.
19
+
The project is organized as follows:
67
20
68
-
Here’s the README translated into English:
21
+
-**`src/`**: Main implementation of the search engine, including reverse indexing and the PageRank algorithm.
22
+
-**`tests/`**: Unit tests to verify the functionality of the system.
23
+
-**`CMakeLists.txt`**: Configuration file for building the project with CMake.
69
24
70
25
---
71
26
72
-
# English Version
73
-
74
-
This project is a simple search engine that utilizes Wikipedia pages. It builds a reverse index for keyword searching and uses the PageRank algorithm to rank pages based on relevance and interlinking.
75
-
76
-
## Requirements
77
-
78
-
Before compiling the project, make sure your environment meets the following requirements:
79
-
80
-
- CMake 3.10 or higher
81
-
- Google Test for unit testing
82
-
- A compiler compatible with C++11 or higher
83
-
84
-
## Project Structure
85
-
86
-
- **src/**: Main implementation of the search engine, including the reverse index and PageRank.
87
-
- **tests/**: Unit tests to verify the functionality of the system.
88
-
- **CMakeLists.txt**: Configuration file for building the project with CMake.
89
-
90
-
## Building the Project
27
+
## 🔧 Building the Project
91
28
92
29
To compile the project, follow these steps:
93
30
@@ -97,36 +34,47 @@ To compile the project, follow these steps:
97
34
mkdir build &&cd build
98
35
```
99
36
100
-
2. Run CMake to generate the build files:
37
+
2. Run **CMake** to generate the build files:
101
38
102
39
```bash
103
40
cmake ..
104
41
```
105
42
106
-
3. Compile the project using `make`:
43
+
3. Compile the project using **make**:
107
44
108
45
```bash
109
46
make
110
47
```
111
48
112
-
## Running Tests
49
+
---
50
+
51
+
## 🧪 Running Tests
113
52
114
-
Since this project is a library, you can run the unit tests to verify its functionality.
53
+
Run unit tests to ensure the correctness of the system.
115
54
116
-
1. After building, inthe `build` directory, execute:
55
+
1. After building the project, navigate to the `build` directory and execute:
117
56
118
57
```bash
119
58
./tests/unit-tests/LibUnitTests
120
59
```
121
60
122
-
This will run the tests covering the search engine functionality, reverse indexing, and PageRank.
61
+
This will run the tests covering search engine functionality, reverse indexing, and the PageRank algorithm.
123
62
124
-
## How It Works
63
+
---
125
64
126
-
- **Reverse Indexing**: Maps keywords to the Wikipedia pages in which they appear.
127
-
- **PageRank**: An algorithm that assigns a relevance score to each page based on links and the structure of Wikipedia.
128
-
- **Querying**: Searches for pages related to a keyword and ranks the results based on PageRank.
65
+
## ⚙️ How It Works
129
66
130
-
## License
67
+
- **Reverse Indexing**: Maps keywords to the documents where they appear.
68
+
- **PageRank**: An algorithm that assigns a relevance score to each document based on its links and structure.
69
+
- **Querying**: Searches for documents related to a keyword and ranks them according to their PageRank score.
131
70
132
71
---
72
+
73
+
## 📄 License
74
+
75
+
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
0 commit comments