You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-21
Original file line number
Diff line number
Diff line change
@@ -19,34 +19,40 @@ This template is an example project for a simple Large Language Model (LLM) appl
19
19
20
20

21
21
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
-
30
22
## Getting Started
31
23
32
24
To get started, follow the below steps:
33
25
34
26
1. Create an `.env` file by copying the `SAMPLE_env` file and add API keys for the models you are going to use
35
27
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).
41
51
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:
43
52
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/). 📚
47
54
48
-
Or edit the `start` script directly:
55
+
-------------
49
56
50
-
```bash
51
-
vite --port 3000
52
-
```
57
+
## Shout out to the ⭐star gazers⭐ supporting the project
58
+
[](https://github.com/golivecosmos/llm-react-node-app-template/stargazers)
0 commit comments