garvit-joshi/redux

A cross-platform Application for storing encrypted User-Data

Redux

A cross-platform Application for storing User-Data.

Building The App from Source(Linux): 🔨

Prerequisites:

• CMake >= 3.1
  
• g++ >= 8 (CXX standard=17)
  
• vcpkg

Steps:

1. Download vcpkg and run

./bootstrap-vcpkg.sh

2. To install the libraries for your project, run the below command in the root directory of vcpkg:

./vcpkg install cryptopp

3. Download Redux and run this command assuming vcpkg is installed in home/username/Repos/vcpkg and Redux is located /home/username/Repos/Redux/

cmake -B /home/username/Repos/Redux/build -S . -DCMAKE_TOOLCHAIN_FILE=/home/username/Repos/vcpkg/scripts/buildsystems/vcpkg.cmake

4. To compile the project run:

cmake --build /home/username/Repos/Redux/build

5. Run The Executable:

./build/src/Redux

Building The App from Source(Windows): 🔨

Prerequisites:

• CMake >= 3.1
• Microsoft Visual Studio 2019
• vcpkg

Steps:

1. Download vcpkg and run /bootstrap-vcpkg.bat

2. For installing required modules, run one of these commands in the root directory of vcpkg:

   • vcpkg install cryptopp:x64-windows (For 64-bit PC)
   • vcpkg install cryptopp:x86-windows (For 32-bit PC)

3. Opening cmd in root directory of Redux, and run these commands assuming your vcpkg is installed in C://vcpkg and Redux is located in D:\Repos\Redux:

   cmake -G "Visual Studio 16 2019" -A Win32 -S . -B "build32" -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
   cmake --build build32 --config Release
   

4. Binaries will be at D:\Repos\Redux\build32\src\Release\Redux.exe

Notes (if using Pre-Build Binaries for Windows):

1. Please Install Microsoft Visual C++ Redistributable for Visual Studio 2019 before running binaries:

   1. For x64,
   2. For x86,
   3. For ARM64.

2. The last thing is simply a matter of perception. If you are running any sort of anti-virus, like ZoneAlarm, Norton, McAfee, etc. then they will get a very unpleasant message about your program trying to do something considered dangerous. It may be due to system(); function used in program. Read more about it here and here