Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ardriveapp/ardrive-sync
The ArDrive Sync Command Line App contains basic public and private file and folder synchronization to the Arweave decentralized network.
https://github.com/ardriveapp/ardrive-sync
Last synced: 3 days ago
JSON representation
The ArDrive Sync Command Line App contains basic public and private file and folder synchronization to the Arweave decentralized network.
- Host: GitHub
- URL: https://github.com/ardriveapp/ardrive-sync
- Owner: ardriveapp
- License: agpl-3.0
- Created: 2021-10-14T05:05:10.000Z (about 3 years ago)
- Default Branch: production
- Last Pushed: 2022-11-18T22:24:31.000Z (almost 2 years ago)
- Last Synced: 2024-10-07T19:47:41.460Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 147 KB
- Stars: 2
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ardrive-sync
The ArDrive Sync Command Line App contains basic public and private drive synchronization via a Node.js application.
It requires you to provide a local Arweave wallet JSON. It stores this, encrypted, in local SQLite database that is created in the directory that you run ArDrive-Sync in, called .ardrive-sync.db. Other file metadata and transaction information is also stored in this database.
To use the ArDrive Sync, install it with your favorite package manager, and run "ardrive-sync".
If you are experiencing permissions issues (Mac OSX), you may also need to place your wallet file in the same directory you are running ardrive-cli
---- THIS IS CURRENTLY A BETA VERSION ----
## Developer Setup
First, clone this repository to a local directory
```shell
git clone -b production https://github.com/ardriveapp/ardrive-sync.git ./ardrive-sync
```
### Install Yarn 2
ArDrive Sync uses Yarn 2, so install the latest version with the [yarn installation instructions][yarn-install]. In most cases:
```shell
# Brew:
brew install yarn
# Or with NPM:
npm install -g yarn
```
We also use husky. To enable hooks locally, you will need to run:
```shell
yarn husky install
```
### Building, Installing and Starting ArDrive Sync
Now that everything is set up, to install the package simply run:
```shell
yarn
```
And then start the ArDrive Sync command line app:
```shell
yarn start
```
### Installing and Starting ArDrive Sync with NPM
ArDrive-Sync is also available via NPM. It can be installed globally by running the following:
```shell
npm install ardrive-sync -g
```
And then start the ArDrive Sync command line app:
```shell
ardrive-sync
```
### Recommended Visual Studio Code extensions
To ensure your environment is compatible, we also recommend the following VSCode extensions:
- [ES-Lint][eslint-vscode]
- [Editor-Config][editor-config-vscode]
- [Prettier][prettier-vscode]
- [ZipFS][zipfs-vscode]
[yarn-install]: https://yarnpkg.com/getting-started/install
[editor-config-vscode]: https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig
[prettier-vscode]: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
[zipfs-vscode]: https://marketplace.visualstudio.com/items?itemName=arcanis.vscode-zipfs
[eslint-vscode]: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
[sqlite-db-webviewer]: https://inloop.github.io/sqlite-viewer/
[sqlite-db-desktopviewer]: https://sqlitebrowser.org/