andras/vault-link
1
0
Fork 0
Code Issues Pull requests 18 Projects Releases 55 Packages Wiki Activity Actions 1

Small readme improvements

Browse source
This commit is contained in:
Andras Schmelczer 2025-08-17 14:59:21 +01:00
parent 278fa912df
commit 0916f54045
No known key found for this signature in database
GPG key ID: FC8F2C3D3D1A718C
1 changed files with 20 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -5,7 +5,6 @@
[![Publish server Docker image](https://github.com/schmelczer/vault-link/actions/workflows/publish-docker.yml/badge.svg)](https://github.com/schmelczer/vault-link/actions/workflows/publish-docker.yml) [![Publish server Docker image](https://github.com/schmelczer/vault-link/actions/workflows/publish-docker.yml/badge.svg)](https://github.com/schmelczer/vault-link/actions/workflows/publish-docker.yml)
[![Publish Obsidian plugin](https://github.com/schmelczer/vault-link/actions/workflows/publish-plugin.yml/badge.svg)](https://github.com/schmelczer/vault-link/actions/workflows/publish-plugin.yml) [![Publish Obsidian plugin](https://github.com/schmelczer/vault-link/actions/workflows/publish-plugin.yml/badge.svg)](https://github.com/schmelczer/vault-link/actions/workflows/publish-plugin.yml)
## Develop ## Develop
### Install [nvm](https://github.com/nvm-sh/nvm) ### Install [nvm](https://github.com/nvm-sh/nvm)
@ -15,7 +14,6 @@
- `nvm use 22` - `nvm use 22`
- Optionally set the system-wide default: `nvm alias default 22` - Optionally set the system-wide default: `nvm alias default 22`
### Set up Rust ### Set up Rust
- Install [`rustup`](https://rustup.rs): `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` - Install [`rustup`](https://rustup.rs): `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
@ -31,6 +29,18 @@ flatpak install flathub md.obsidian.Obsidian
flatpak run md.obsidian.Obsidian flatpak run md.obsidian.Obsidian
``` ```
#### Run in development mode
Start the server:
```sh
cd sync-server && cargo run config-e2e.yml
```
```sh
cd frontend && npm run dev
```
### Scripts ### Scripts
#### Update HTTP API TS bindings #### Update HTTP API TS bindings
@ -45,7 +55,6 @@ scripts/update-api-types.sh
scripts/bump-version.sh patch scripts/bump-version.sh patch
``` ```
#### Run E2E tests #### Run E2E tests
```sh ```sh