isaquescoelho / syncmatejs

SyncMateJS: An efficient and intuitive data backup and synchronization solution, built with JavaScript and Node.js. Ideal for automating local and cloud backups with a user-friendly graphical interface.

SyncMateJS

SyncMateJS is a powerful Electron-based tool designed to simplify your file backup and synchronization needs.

Features

• Backup: Easily back up files and directories.
• Synchronization: Keep files synchronized across different locations.
• Log Tracking: View a log of all backup and synchronization activities.

Getting Started

Prerequisites

Before installing SyncMateJS, ensure you have Node.js installed on your system. This will include npm, which is necessary to install dependencies and run the project.

Installation

1. Clone the SyncMateJS repository to your local machine:

    git clone https://github.com/isaquescoelho/SyncMateJS

2. Navigate to the SyncMateJS directory:

    cd yourpath/SyncMateJS

3. Install the dependencies:

• Using npm:

  npm install
  

• Or using yarn:

  yarn install
  

Running SyncMateJS

To start the application, run:

• Using npm:

  npm start

• Or using yarn:

  yarn start

The SyncMateJS application should now open on your desktop.

Usage

Backup Files or Directories

1. Open SyncMateJS.
2. Use the Source Path selector to choose the file or directory you want to back up.
3. Click the Start Backup button. The progress will be displayed in the log section.

View Logs

After the backup is complete, check the log section for details of the operation.

Troubleshooting

If you encounter any issues, refer to the log section for error messages. Ensure that SyncMateJS has the necessary permissions to access the directories.

License

SyncMateJS is released under the MIT License. See the LICENSE file for more details.

syncmatejs's Issues

How to start it?

Where's the docs for I run it?

How to start the project?

• I try it, but I catch follow error: