Skip to content

Commit c8ec99f

Browse files
authored
Merge pull request #2 from golivecosmos/katrinar-patch-1
Update README.md
2 parents de9662b + 6b9ae36 commit c8ec99f

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

README.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
<h1 align='center' >
2-
LLM React App Javascript Template 🪄
2+
🪐 LLM React App Javascript Template 🪐
33
</h1>
44
<p align='center'>
55
<a href='https://github.com/golivecosmos/pluto/blob/main/LICENSE'>
6-
<img src='https://img.shields.io/github/license/golivecosmos/llm-react-node-app-template' alt='License' />
6+
<img src='https://img.shields.io/github/license/golivecosmos/llm-react-node-app-template?style=plastic' alt='License' />
77
</a>
8-
<a href='https://twitter.com/golivecosmos'>
9-
<img src='https://img.shields.io/twitter/follow/golivecosmos?style=social' alt='Cosmos' style='margin-right:3px' />
10-
</a>
8+
<a href='https://github.com/golivecosmos/llm-react-node-app-template'>
9+
<img src='https://img.shields.io/github/commit-activity/w/golivecosmos/llm-react-node-app-template?style=plastic' alt='Cosmos' style='margin-right:3px' />
10+
</a>
11+
<a href='https://twitter.com/golivecosmos'>
12+
<img src='https://img.shields.io/twitter/follow/golivecosmos' alt='Cosmos' style='margin-right:3px' />
13+
</a>
1114
</p>
1215

1316
## What is an LLM React Node App Javascript Template?
1417

1518
This template is an example project for a simple Large Language Model (LLM) application built on top of React and Node. This template was built on top of [the React template app from nano-react-app](https://github.com/nano-react-app/template-js) and updated with a Node server that uses [LangChain.js](https://github.com/hwchase17/langchainjs) to connect to supported large language models, e.g. OpenAI and Hugging Face. Use this template to easily build and run an LLM app, like the screenshot below:
1619

17-
![screenshot of LLM react app](./examples/llm-react-app.png)
20+
![screenshot of LLM react app](./examples/llm-react-app.webp)
1821

1922
These are the available commands:
2023

@@ -26,8 +29,13 @@ These are the available commands:
2629

2730
## Getting Started
2831

29-
To get started, create a `.env` file by copying the `SAMPLE_env` file. Then, add your Open API key to the file.
30-
Now you are ready to run the server and the web app.
32+
To get started, follow the below steps:
33+
34+
1. Create an `.env` file by copying the `SAMPLE_env` file and add API keys for the models you are going to use
35+
1. Install packages
36+
1. Run the backend and frontend servers
37+
38+
For more thorough step-by-step instructions follow [this tutorial on running an LLM React Node app](https://blog.golivecosmos.com/build-an-llm-app-with-node-react-and-langchain-js/).
3139

3240
## Custom port
3341

examples/llm-react-app.png

-103 KB
Binary file not shown.

examples/llm-react-app.webp

37.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)