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
These instructions will get you a copy of the project and ready for on your local machine.
9
+
These instructions will get you a copy of the project and ready for use on your local machine.
10
10
11
11
### Prerequisites
12
+
13
+
#### Quick Access
14
+
- Click on the link to download the tool - [Interact.zip](https://github.com/KrishnanSG/Interact/files/3835348/Interact.zip)
15
+
16
+
- Extract the zip folder
17
+
18
+
#### Developer Style
12
19
- Python 3.7
13
20
14
21
- Clone this repository using the command:
@@ -29,6 +36,24 @@ These instructions will get you a copy of the project and ready for on your loca
29
36
You're almost there.
30
37
The following steps will guide you on how to use this tool.
31
38
39
+
#### Quick Access
40
+
> Use the following commands if you have downloaded the tool using steps described in quick access.
41
+
42
+
1. Open your favourite terminal
43
+
44
+
2. Creating host server
45
+
```
46
+
./Interact.exe <filename> --host
47
+
```
48
+
3. Ask your friend to connect to the server
49
+
```
50
+
./Interact <filename>
51
+
52
+
Provide inputs for the prompt messages.
53
+
```
54
+
55
+
#### Developer Stlye
56
+
32
57
1. Creating host server
33
58
```
34
59
python main.py <filename> --host
@@ -41,18 +66,29 @@ The following steps will guide you on how to use this tool.
41
66
Provide inputs for the prompt messages.
42
67
```
43
68
44
-
3. Enjoy the sync. We automatically detect for modification made in the file, so just save the file.
69
+
3. Enjoy Interact :) . We automatically detect for modification made in the file, so just save the file.
70
+
71
+
> You may use the following command to get help regarding the tool
72
+
```
73
+
./Interact.exe --help or python main.py --help
74
+
```
45
75
46
76
## How does this work?
47
77
48
-
Most the of the file synchronziers send the complete file across the network for every sync cycle.
78
+
Most of the file synchronziers send the complete file across the network for every sync cycle, this causes unnecessary data transfer.
79
+
80
+
Let's consider this case where you make a modification on line 10 but your file containing 1000 lines is sent across the network.
81
+
82
+
" To solve this problem **Interact** was developed. "
49
83
50
84
### How we do it?
51
-
**BloomFilters**
85
+
86
+
**BloomFilter**
52
87
53
88
A Bloom filter is a space-efficient probabilistic data structure that is used to test whether an element is a member of a set. Check out this [link](https://www.geeksforgeeks.org/bloom-filters-introduction-and-python-implementation/) to know more.
54
89
55
90
### The protocol
91
+
56
92
We will be using a few terms in the due course of the explanation.
57
93
- **Host** - the user who has intiated the P2P server.
0 commit comments