Skip to content

Commit f18383a

Browse files
committed
Merge branch 'main' into support-hf
2 parents dcf8d95 + b4887d9 commit f18383a

File tree

1 file changed

+27
-21
lines changed

1 file changed

+27
-21
lines changed

README.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -19,34 +19,40 @@ This template is an example project for a simple Large Language Model (LLM) appl
1919

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

22-
These are the available commands:
23-
24-
- `yarn start` — This will start a React development server for the frontend app, with a default port of `5173`.
25-
- `yarn start-server` — This will start a Node development server for the backend app, with a default port of `3100`.
26-
27-
- `yarn build` — This will output a production build of the frontend app in the `dist` directory.
28-
- `yarn preview` — This will run the production build of the frontend app locally with a default port of `5173` (_note_: this will not work if you haven't generated the production build yet).
29-
3022
## Getting Started
3123

3224
To get started, follow the below steps:
3325

3426
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
3527
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/).
39-
40-
## Custom port
28+
1. Run the backend server that will start with a default port of `3100`
29+
```bash
30+
yarn start-server
31+
```
32+
1. Run the frontend server that will start with a default port of `5173`.
33+
```bash
34+
yarn start
35+
```
36+
37+
_Note:_ You can use the `-p` flag to specify a port for the frontend server. To do this, you can either run `yarn start` with an additional flag, like so:
38+
```bash
39+
yarn start -- --port 3000
40+
```
41+
42+
Or, edit the `start` script directly:
43+
44+
```bash
45+
vite --port 3000
46+
```
47+
48+
Additional scripts are provided to prepare the app for production
49+
- `yarn build` — This will output a production build of the frontend app in the `dist` directory.
50+
- `yarn preview` — This will run the production build of the frontend app locally with a default port of `5173` (_note_: this will not work if you haven't generated the production build yet).
4151
42-
You can use the `-p` flag to specify a port for development. To do this, you can either run `npm start` with an additional flag:
4352
44-
```bash
45-
yarn start -- --port 3000
46-
```
53+
👽 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/). 📚
4754

48-
Or edit the `start` script directly:
55+
-------------
4956

50-
```bash
51-
vite --port 3000
52-
```
57+
## Shout out to the ⭐star gazers⭐ supporting the project
58+
[![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)

0 commit comments

Comments
 (0)