Skip to content

Commit 7be9113

Browse files
authored
Update README.md
1 parent 1db964a commit 7be9113

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
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'>
@@ -13,17 +13,17 @@
1313
</a>
1414
</p>
1515

16-
## What is an LLM React Node App Javascript Template?
16+
## What is this template?
1717

18-
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:
18+
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 [HuggingFace.js](https://github.com/huggingface/huggingface.js) and [LangChain.js](https://github.com/hwchase17/langchainjs) to connect to supported large language models. Use this template to easily build and run an LLM app, like the screenshot below:
1919

2020
![screenshot of LLM react app](./examples/llm-react-app.webp)
2121

2222
## Getting Started
2323

2424
To get started, follow the below steps:
2525

26-
1. Create an `.env` file by copying the `SAMPLE_env` file and add the model store provider you'll be using (e.g. HuggingFace or OpenAI) and the API keys for the models you are going to use
26+
1. Create an `.env` file by copying the `SAMPLE_env` file and add the model store provider you'll be using (e.g. `HUGGING_FACE` or `OPEN_AI`) and the API keys for the models you are going to use
2727
1. Install packages
2828
1. Run the backend server that will start with a default port of `3100`
2929

@@ -56,18 +56,18 @@ Additional scripts are provided to prepare the app for production
5656
5757
### Tutorials
5858
59-
👽 If you're looking for more thorough 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/). 📚
59+
👽 Looking for more content? Check out [our tutorials on running LLM apps](https://blog.golivecosmos.com/posts/) 📚
6060
6161
-------------
6262
6363
## How to Contribute
6464
6565
Feel free to try out the template and open any issues if there's something you'd like to see added or fixed, or open a pull request to contribute.
6666
67-
### Shout out to the ⭐star gazers⭐ supporting the project
67+
#### Shout out to the ⭐star gazers⭐
6868
6969
[![Stargazers repo roster for @golivecosmos/llm-react-node-app-template](https://reporoster.com/stars/golivecosmos/llm-react-node-app-template)](https://github.com/golivecosmos/llm-react-node-app-template/stargazers)
7070
71-
### Thanks for the forks🍴
71+
#### Thanks for the forks🍴
7272
73-
[![Forkers repo roster for @golivecosmos/llm-react-node-app-template](https://reporoster.com/forks/golivecosmos/llm-react-node-app-template)](https://github.com/golivecosmos/llm-react-node-app-template/network/members)
73+
[![Forkers repo roster for @golivecosmos/llm-react-node-app-template](https://reporoster.com/forks/golivecosmos/llm-react-node-app-template)](https://github.com/golivecosmos/llm-react-node-app-template/network/members)

0 commit comments

Comments
 (0)