Updated desktop readme with nvm info (#2137)
This commit is contained in:
+10
-4
@@ -1,12 +1,18 @@
|
||||
# Goose App
|
||||
# Goose Desktop App
|
||||
|
||||
Mac (and maybe windows?) app for Goose.
|
||||
Native desktop app for Goose built with [Electron](https://www.electronjs.org/) and [ReactJS](https://react.dev/).
|
||||
|
||||
# Prerequisites
|
||||
- [nvm](https://github.com/nvm-sh/nvm) (recommended for managing node versions easier but not required)
|
||||
- node major version equal to or greater than specified in .nvmrc and package.json
|
||||
- [rust](https://www.rust-lang.org/tools/install) (for building the server)
|
||||
|
||||
```
|
||||
git clone git@github.com:block/goose.git
|
||||
cd goose/ui/desktop
|
||||
nvm use
|
||||
npm install
|
||||
npm start
|
||||
npm run start
|
||||
```
|
||||
|
||||
# Building notes
|
||||
@@ -28,7 +34,7 @@ see `package.json`:
|
||||
This allows you to set for example GOOSE_PROVIDER__TYPE to be "databricks" by default if you want (so when people start Goose.app - they will get that out of the box). There is no way to set an api key in that bundling as that would be a terrible idea, so only use providers that can do oauth (like databricks can), otherwise stick to default goose.
|
||||
|
||||
|
||||
# Runninng with goosed server from source
|
||||
# Running with goosed server from source
|
||||
|
||||
Set `VITE_START_EMBEDDED_SERVER=yes` to no in `.env`.
|
||||
Run `cargo run -p goose-server` from parent dir.
|
||||
|
||||
Reference in New Issue
Block a user