Skip to content

Commit

Permalink
Merge branch 'main' of github.com:valory-xyz/olas-operate-app into fe…
Browse files Browse the repository at this point in the history
…at/win-support
  • Loading branch information
solarw committed Aug 30, 2024
2 parents 5d6b007 + e6128a4 commit b398318
Showing 1 changed file with 3 additions and 41 deletions.
44 changes: 3 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Pearl is an application used to run autonomous agents powered by the OLAS Networ
- Javascript / TypeScript
- Python (3.10)
- Poetry (^1.7.1)
- Docker Engine

## Getting Started

Expand All @@ -26,7 +25,7 @@ The following installation steps assume you have the following on each OS:

<details><summary><h4>NodeJS</summary></h4>

NodeJS is best installed and managed through NVM. It allows you to install and select specific versions of NodeJS. Pearl has been built using version 20.11, LTS.
NodeJS is best installed and managed through NVM. It allows you to install and select specific versions of NodeJS. Pearl has been built using version 20 LTS.

<h5>Linux</h5>

Expand Down Expand Up @@ -117,38 +116,6 @@ If promoted to run `pipx ensurepath`, run it.

</details>

<details><summary><h4>Docker</h4></summary>

<h5>Linux</h5>

*Update the `ubuntu.22.04~jammy` version string to your current OS version before running the following command:*

```bash
VERSION_STRING=5:24.0.7-1~ubuntu.22.04~jammy
sudo apt-get install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin
sudo usermod -aG docker $USER
```

If you are unsure about your current OS version/codename, you can find it by running:

```bash
lsb_release -a
```

<h5>MacOS</h5>

You can [install Docker Desktop via the Docker website](https://www.docker.com/products/docker-desktop/). Be sure to select the correct version for your system's CPU architecture.

If you are unsure about your system's CPU architecture, run the following command:

```bash
uname -p
# x86 64 Intel chip
# arm64 Apple chip
```

</details>

<h3>Setting up your .env file</h3>

Create an `.env` file in the root directory, or rename `.env.example` to `.env`.
Expand Down Expand Up @@ -202,7 +169,7 @@ Provided your system dependencies are installed, environment variables are set,
You can start Pearl by running the following command in the root directory:

```bash
yarn start
yarn dev
```

This will run Electron, which launches the NextJS frontend and the Python backend as child processes.
Expand Down Expand Up @@ -254,9 +221,4 @@ poetry run python scripts/fund.py 0xYOURADDRESS
poetry run python scripts/transfer_olas.py PATH_TO_KEY_CONTAINING_OLAS ADDRESS_TO_TRANSFER AMOUNT
```

</details>

<h2>Notes and Common Issues</h2>

- If Pearl is running, it will kill any attempt to run another Pearl instance. This is to ensure there are no port conflicts.
- Enivironment variables are cached in the terminal, if you change them while your terminal is open, you will need to restart the terminal.
</details>

0 comments on commit b398318

Please sign in to comment.