mirror of
https://github.com/amithkoujalgi/ollama4j.git
synced 2025-05-14 19:37:11 +02:00
Add dev setup instructions and update pre-commit config
This commit is contained in:
parent
b638b981c9
commit
983a3617f0
@ -21,7 +21,7 @@ repos:
|
|||||||
|
|
||||||
# for commit message formatting
|
# for commit message formatting
|
||||||
- repo: https://github.com/commitizen-tools/commitizen
|
- repo: https://github.com/commitizen-tools/commitizen
|
||||||
rev: v4.1.1
|
rev: v4.4.1
|
||||||
hooks:
|
hooks:
|
||||||
- id: commitizen
|
- id: commitizen
|
||||||
stages: [commit-msg]
|
stages: [commit-msg]
|
||||||
|
7
Makefile
7
Makefile
@ -1,3 +1,10 @@
|
|||||||
|
dev:
|
||||||
|
@echo "Setting up dev environment..."
|
||||||
|
@command -v pre-commit >/dev/null 2>&1 || { echo "Error: pre-commit is not installed. Please install it first."; exit 1; }
|
||||||
|
pre-commit install
|
||||||
|
pre-commit autoupdate
|
||||||
|
pre-commit install --install-hooks
|
||||||
|
|
||||||
build:
|
build:
|
||||||
mvn -B clean install
|
mvn -B clean install
|
||||||
|
|
||||||
|
33
README.md
33
README.md
@ -191,33 +191,54 @@ dependencies {
|
|||||||
> [!TIP]
|
> [!TIP]
|
||||||
> Find the full API specifications on the [website](https://ollama4j.github.io/ollama4j/).
|
> Find the full API specifications on the [website](https://ollama4j.github.io/ollama4j/).
|
||||||
|
|
||||||
#### Development
|
### Development
|
||||||
|
|
||||||
Build:
|
Make sure you have `pre-commit` installed.
|
||||||
|
|
||||||
|
With `brew`:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
brew install pre-commit
|
||||||
|
```
|
||||||
|
|
||||||
|
With `pip`:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pip install pre-commit
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Setup dev environment
|
||||||
|
|
||||||
|
```shell
|
||||||
|
make dev
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Build
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
make build
|
make build
|
||||||
```
|
```
|
||||||
|
|
||||||
Run unit tests:
|
#### Run unit tests
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
make unit-tests
|
make unit-tests
|
||||||
```
|
```
|
||||||
|
|
||||||
Run integration tests:
|
#### Run integration tests
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
make integration-tests
|
make integration-tests
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Releases
|
### Releases
|
||||||
|
|
||||||
Newer artifacts are published via GitHub Actions CI workflow when a new release is created from `main` branch.
|
Newer artifacts are published via GitHub Actions CI workflow when a new release is created from `main` branch.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
The `ollama4j-examples` repository contains examples for using the Ollama4j library. You can explore it [here](https://github.com/ollama4j/ollama4j-examples).
|
The `ollama4j-examples` repository contains examples for using the Ollama4j library. You can explore
|
||||||
|
it [here](https://github.com/ollama4j/ollama4j-examples).
|
||||||
|
|
||||||
## ⭐ Give us a Star!
|
## ⭐ Give us a Star!
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user