surrealdb / surrealist

Surrealist is the ultimate way to visually manage your SurrealDB database
https://surrealist.app/
MIT License
1.03k stars 73 forks source link

Add documentation for building and running the app #297

Open winksaville opened 1 month ago

winksaville commented 1 month ago

Describe your feature request Add documentation to show how to build the executable and then run that executable from the command line.

*** Building from within src-tauri/ directory:

$ pnpm tauri build --no-bundle

> surrealist@2.0.6 tauri /home/wink/prgs/SurrealDB/surrealist
> tauri "build" "--no-bundle"

    Running beforeBuildCommand `pnpm build`
...
   Compiling muda v0.13.1
   Compiling tauri-plugin-localhost v2.0.0-beta.4
   Compiling tauri-plugin-single-instance v2.0.0-beta.7
    Finished `release` profile [optimized] target(s) in 1m 23s

*** Running from within src-tauri/ directory:

$ ./target/release/surrealist 
[2024-05-24][21:11:29][tracing::span][TRACE] async_io::block_on;
[2024-05-24][21:11:29][surrealist][INFO] Launch args: Args { inner: ["./target/release/surrealist"] }
[2024-05-24][21:11:29][tracing::span::active][TRACE] -> async_io::block_on;
...

Are you willing to contribute this feature? Yes

Related pull request (if applicable) No PR yet, I like to know where the to put it