Sync-Fy is a project focused on implementing a service akin to Dropbox, enabling seamless sharing and automatic synchronization of files across various devices belonging to the same user. The application is designed to run in Unix environments, specifically on Linux. The implementation leverages the Unix Transmission Control Protocol (TCP) sockets API, inotify API and C++.
-
CMake: This project requires CMake version 23 or higher. You can check your current version with
cmake --version. If you need to upgrade, visit the CMake download page. -
Conan: Conan is a portable package manager for C/C++ developers. If you don't have it installed, you can follow the instructions on the Conan's installation guide.
-
C++ Compiler: This project requires a C++ compiler that supports C++23. We recommend using GCC 11.4.0 or higher. You can check your current version with
gcc --version. If you need to upgrade, visit the GCC download page.You may install cmake and conan with pip with the following command:
pip install cmake conan
-
(optional) Doxygen: This project uses Doxygen for documentation, if you would like to consult it via a web browser install Doxygen in your machine.
You may generate this project Doxygen documentation has a
htmlpage by running the following command in the root of the project:doxygen Doxyfile
To visualize the generated documentation, open the generated
index.htmlfile on a browser or do it via the terminal with:firefox docs/html/index.html
You may use your preferred browser for this instead of
firefox.
After ensuring that the requirements are met, follow these steps:
-
Run
conan install conanfile.txtto install the necessary dependencies. -
Run
cmake --build ./build/Release --target allto generate the build files. -
Run
./build/Release/server/serverto run the server app. -
Run
./build/Release/client/clientto run the client app.
To test the application you can use the provided docker-compose:
- Run
docker-compose upto start the containers (1 server and 3 clients). - Attach a shell to the desired client with
docker exec -it {container-id} bash - Run the client with
../scripts/run-client.sh {username} primary-serveron the attached container. - The tests/files folder is binded to the container, so you can add files there to test the commands.
We recommend using gitmoji-cli for commit messages. It's a simple CLI that helps you to use emojis on your commit messages. If you don't have it installed, you can install it with the following command:
npm i -g gitmoji-cliAlso install the git hook using the following command:
gitmoji -iThen use the following to commit your changes:
git add .
git commitRemember, the use of gitmoji-cli is not mandatory, but it helps to make the commit history clear and easy to understand.
If using vs code, run the following command to install the recommended extensions:
code --install-extension ms-vscode.cpptools-extension-pack ms-vscode.cmake-tools seatonjiang.gitmoji-vscodeOr simply press Ctrl+Shift+P and type Show Recommended Extensions