Skip to content
Snippets Groups Projects
Commit 9e2e5a3f authored by Marcus Schiesser's avatar Marcus Schiesser
Browse files

doc: update readmes

parent 3df7fd6d
No related branches found
No related tags found
No related merge requests found
...@@ -17,14 +17,14 @@ pnpm create llama-app ...@@ -17,14 +17,14 @@ pnpm create llama-app
bunx create-llama bunx create-llama
``` ```
You will be asked for the name of your project, and then whether you want to You will be asked for the name of your project, and then which framework you want to use
create a TypeScript project: create a TypeScript project:
```bash ```bash
✔ Would you like to use TypeScript? No / Yes ✔ Which framework would you like to use? NextJS
``` ```
Select **Yes** to install the necessary types/dependencies and create a new TS project. You can choose between NextJS and Express.
### Non-interactive ### Non-interactive
......
1. Install the dependencies This is a [LlamaIndex](https://www.llamaindex.ai/) project using [Express](https://expressjs.com/) bootstrapped with [`create-llama`](https://github.com/run-llama/LlamaIndexTS/tree/main/packages/create-llama).
## Getting Started
First, install the dependencies:
``` ```
pnpm install npm install
``` ```
2. Run the server Second, run the development server:
``` ```
pnpm run dev npm run dev
``` ```
3. Call the API to LLM Chat Then call the express API endpoint `/api/llm` to see the result:
``` ```
curl --location 'localhost:3000/api/llm' \ curl --location 'localhost:3000/api/llm' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
...@@ -16,4 +23,15 @@ curl --location 'localhost:3000/api/llm' \ ...@@ -16,4 +23,15 @@ curl --location 'localhost:3000/api/llm' \
"message": "Hello", "message": "Hello",
"chatHistory": [] "chatHistory": []
}' }'
``` ```
\ No newline at end of file
You can start editing the API by modifying `src/controllers/llm.controller.ts`. The endpoint auto-updates as you save the file.
## Learn More
To learn more about LlamaIndex, take a look at the following resources:
- [LlamaIndex Documentation](https://docs.llamaindex.ai) - learn about LlamaIndex (Python features).
- [LlamaIndexTS Documentation](https://ts.llamaindex.ai) - learn about LlamaIndex (Typescript features).
You can check out [the LlamaIndexTS GitHub repository](https://github.com/run-llama/LlamaIndexTS) - your feedback and contributions are welcome!
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment