a2578d7ff1
snapshot_release / snapshot_release (push) Has been cancelled
Documentation: build and deploy / deploy (push) Has been cancelled
langchain4j-github-bot.yml lint / langchain4j-github-bot.yml validation (push) Has been cancelled
Java CI / compile_and_unit_test (17) (push) Has been cancelled
Java CI / compile_and_unit_test (21) (push) Has been cancelled
Java CI / compile_and_unit_test (25) (push) Has been cancelled
Split Package Detection / check-split-packages (push) Has been cancelled
Java CI / integration_test (21) (push) Has been cancelled
Java CI / compliance (push) Has been cancelled
Java CI / spotless (push) Has been cancelled
43 lines
871 B
Markdown
43 lines
871 B
Markdown
## LangChain4j Documentation
|
|
|
|
### Table of Contents
|
|
|
|
- [Prerequisites](#prerequisites)
|
|
- [Installation](#installation)
|
|
|
|
This is built using [Docusaurus](https://docusaurus.io/), a modern static docs/website generator.
|
|
|
|
### Prerequisites
|
|
|
|
- [Node.JS](https://nodejs.org/en/download) (20+)
|
|
|
|
If Node.js is managed by Node Version Manager (nvm), run:
|
|
```shell
|
|
nvm use
|
|
```
|
|
|
|
### Installation
|
|
|
|
This command installs all the Node dependencies.
|
|
|
|
```bash
|
|
npm ci
|
|
```
|
|
|
|
### Build
|
|
|
|
This command builds the deployable static artifacts (i.e., html, js, css, etc) under the `build` directory. This static content can then be deployed to `GitHub pages` or `Vercel`, etc.
|
|
|
|
```
|
|
npm run build
|
|
```
|
|
|
|
### Local Development
|
|
|
|
This command starts a local development server and opens up a browser window. Most changes are reflected live without
|
|
having to restart the server.
|
|
|
|
```
|
|
npm run start
|
|
```
|