Skip to content

Commit

Permalink
chore(readme): add bee-stack info
Browse files Browse the repository at this point in the history
Signed-off-by: Petr Kadlec <[email protected]>
  • Loading branch information
kapetr committed Oct 28, 2024
1 parent 11403d7 commit 422166e
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ With Bee UI, users can build and test custom bees that address unique workflows

## Getting Started

The simplest way to run bee-ui is by using our [bee-stack](https://github.com/i-am-bee/bee-stack), which lets you set up the entire bee application stack locally via docker compose

If you already have a working [bee-api](https://github.com/i-am-bee/bee-api) instance or can set one up, follow the steps below."


### Set-up Node.js environment

Install the correct version of Node.js according to `.nvmrc`. This can be done using [nvm](https://github.com/nvm-sh/nvm): `nvm install && nvm use` or using [asdf](https://asdf-vm.com/): `asdf plugin-add nodejs && asdf install nodejs`.
Expand All @@ -28,6 +33,14 @@ Install dependencies by running:
pnpm install
```

### Set up environment

Create a `.env.local` file (see `.env.local.example` for all variables available) and set `API_URL` to point to your [bee-api](https://github.com/i-am-bee/bee-api) instance.

```
API_URL=http://localhost:4000/
```

### Run the development server

First, run the development server:
Expand Down

0 comments on commit 422166e

Please sign in to comment.