Skip to content

Commit

Permalink
Update README with instruction to build locally (#725)
Browse files Browse the repository at this point in the history
* Add README instructions for building Xef

* Include reasons why build may fail if you don't have docker
  • Loading branch information
raulraja committed May 2, 2024
1 parent 6a3fa58 commit 5fb134f
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,17 @@ In [this](https://xef.ai/learn/quickstart/) small introduction we look at the ma
## 🚀 Examples

You can also have a look at the [examples](https://github.com/xebia-functional/xef/tree/main/examples/src/main/kotlin/com/xebia/functional/xef/conversation) to have a feeling of how using the library looks like.

## 🚧 Local Development

To build the project locally, you can use the following commands:

```shell
./gradlew downloadOpenAIAPI
./gradlew openaiClientGenerate
./gradlew build
```

The server and postgres tests may fail if you don't have [Docker](https://www.docker.com/) installed.
The server and postgres related tests depend on [Testcontainers](https://testcontainers.com/), which in turn depends on Docker.

0 comments on commit 5fb134f

Please sign in to comment.