85 lines
2.5 KiB
Markdown
85 lines
2.5 KiB
Markdown
# VaultLink self-hosted Obsidian plugin for file syncing
|
|
|
|
[](https://github.com/schmelczer/vault-link/actions/workflows/check.yml)
|
|
[](https://github.com/schmelczer/vault-link/actions/workflows/e2e.yml)
|
|
[](https://github.com/schmelczer/vault-link/actions/workflows/publish-server-docker.yml)
|
|
[](https://github.com/schmelczer/vault-link/actions/workflows/publish-cli-docker.yml)
|
|
[](https://github.com/schmelczer/vault-link/actions/workflows/publish-plugin.yml)
|
|
|
|
## Develop
|
|
|
|
### Set up Node.JS 25 with [nvm](https://github.com/nvm-sh/nvm)
|
|
|
|
- `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash`
|
|
- `nvm install 25`
|
|
- `nvm use 25`
|
|
- Optionally, set the system-wide default: `nvm alias default 25`
|
|
|
|
### Set up Rust
|
|
|
|
- Install [`rustup`](https://rustup.rs): `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
|
|
- Install [`wasm-pack`](https://rustwasm.github.io/wasm-pack/installer): `curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh`
|
|
- `cargo install cargo-insta sqlx-cli`
|
|
|
|
### Install Obsidian on Linux
|
|
|
|
```sh
|
|
apt install flatpak
|
|
flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
|
|
flatpak install flathub md.obsidian.Obsidian
|
|
flatpak run md.obsidian.Obsidian
|
|
```
|
|
|
|
#### Run in development mode
|
|
|
|
Start the server:
|
|
|
|
```sh
|
|
cargo install sqlx-cli
|
|
cd sync-server
|
|
cargo run config-e2e.yml
|
|
```
|
|
|
|
```sh
|
|
cd frontend
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
### Common Tasks
|
|
|
|
This project uses [Taskfile](https://taskfile.dev/) for task automation. Run `task --list` to see all available tasks.
|
|
|
|
#### Before pushing
|
|
|
|
```sh
|
|
task check:fix
|
|
```
|
|
|
|
#### Update HTTP API TS bindings
|
|
|
|
```sh
|
|
task update-api-types
|
|
```
|
|
|
|
#### Publish new version
|
|
|
|
```sh
|
|
task release:bump -- patch
|
|
```
|
|
|
|
#### Run E2E tests
|
|
|
|
```sh
|
|
task e2e -- 8
|
|
```
|
|
|
|
And to clean up the logs & database files, run `task clean`
|
|
|
|
## Projects
|
|
|
|
- [Sync server](./sync-server/README.md)
|
|
|
|
a create that has been processed by the server but got lost on the way back will create a 2nd doc if it gets edited
|
|
|
|
remove force merge everywhere
|