Skip to content

Commit 212ab5b

Browse files
Merge pull request #1180 from dfinity/jessiemongeon1-patch-11
standardize README
2 parents e2fd677 + c2af4dd commit 212ab5b

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

motoko/llm_chatbot/README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,15 @@
33
The LLM Chatbot example demonstrates how an ICP smart contract can be used to interact with a large language model (LLM) to generate text. The user can input a prompt, and the smart contract will use the LLM to generate a response.
44
The response is then returned to the user, and the user can submit some follow-up prompts to continue the conversation.
55

6-
This application's logic is written in [Motoko](https://internetcomputer.org/docs/motoko/main/getting-started/motoko-introduction), a programming language designed specifically for developing canisters on ICP.
7-
86
## Deploying from ICP Ninja
97

108
When viewing this project in ICP Ninja, you can deploy it directly to the mainnet for free by clicking "Deploy" in the upper right corner. Open this project in ICP Ninja:
119

1210
[![](https://icp.ninja/assets/open.svg)](https://icp.ninja/i?g=https://github.com/dfinity/examples/motoko/llm_chatbot)
1311

14-
## Project structure
15-
16-
The `/backend` folder contains the Motoko canister, `app.mo`. The `/frontend` folder contains web assets for the application's user interface. The user interface is written using the React framework. Edit the `mops.toml` file to add [Motoko dependencies](https://mops.one/) to the project.
17-
1812
## Build and deploy from the command-line
1913

20-
To migrate your ICP Ninja project off of the web browser and develop it locally, follow these steps. These steps are necessary if you want to deploy this project for long-term, production use on the mainnet.
21-
22-
### 1. Download your project from ICP Ninja using the 'Download files' button on the upper left corner under the pink ninja star icon.
14+
### 1. [Download and install the IC SDK.](https://internetcomputer.org/docs/building-apps/getting-started/install)
2315

2416
### 2. Setting up Ollama
2517

@@ -39,4 +31,16 @@ ollama run llama3.1:8b
3931

4032
The above command will download an 8B parameter model, which is around 4GiB. Once the command executes and the model is loaded, you can terminate it. You won't need to do this step again.
4133

42-
### 3. Open the `BUILD.md` file for further instructions.
34+
### 3. Download your project from ICP Ninja using the 'Download files' button on the upper left corner, or [clone the GitHub examples repository.](https://github.com/dfinity/examples/)
35+
36+
### 4. Navigate into the project's directory.
37+
38+
### 5. Deploy the project to your local environment:
39+
40+
```
41+
dfx start --background --clean && dfx deploy
42+
```
43+
44+
## Security considerations and best practices
45+
46+
If you base your application on this example, it is recommended that you familiarize yourself with and adhere to the [security best practices](https://internetcomputer.org/docs/building-apps/security/overview) for developing on ICP. This example may not implement all the best practices.

0 commit comments

Comments
 (0)