Skip to content

getting-started.md

Latest commit

 

History

History
71 lines (46 loc) · 1.68 KB

getting-started.md

File metadata and controls

71 lines (46 loc) · 1.68 KB

Getting Started

Installing Tools

You will need to install:

Optionally, you can install mkdocs to build and view the documentation locally rather than using a code editor or GitHub.

Configuration

Configuring Ollama

Ollama models need to be pulled before running the project:

ollama pull gpt-oss:20b

The project will not pull the model automatically.

Configuring a Brave API Key

Some examples in the project require a Brave API key. You can get one from the Brave Developer Portal. Place the key in src/main/resources/application-local.yml, e.g.:

com.brave.search.apiKey: YOUR_API_KEY

Building the Project

This project uses Gradle to build. You can run linting and tests from the project root with:

./gradlew check

Running the Project

Make sure that Docker and Ollama are ready:

ollama -v

Running the Application

The Gradle wrapper can be used to run the application:

./gradlew bootRun

Viewing the Documentation

The documentation can be viewed locally with:

mkdocs serve

The documentation will be available at http://localhost:8000/.