Skip to content

Commit 11d6759

Browse files
committed
update tutorials and how to contribute
1 parent f18383a commit 11d6759

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,19 @@ To get started, follow the below steps:
2626
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
2727
1. Install packages
2828
1. Run the backend server that will start with a default port of `3100`
29+
2930
```bash
3031
yarn start-server
3132
```
33+
3234
1. Run the frontend server that will start with a default port of `5173`.
35+
3336
```bash
3437
yarn start
3538
```
36-
39+
3740
_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:
41+
3842
```bash
3943
yarn start -- --port 3000
4044
```
@@ -44,15 +48,26 @@ To get started, follow the below steps:
4448
```bash
4549
vite --port 3000
4650
```
47-
51+
4852
Additional scripts are provided to prepare the app for production
53+
4954
- `yarn build` — This will output a production build of the frontend app in the `dist` directory.
5055
- `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).
5156
57+
### Tutorials
5258
5359
👽 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/). 📚
5460

5561
-------------
5662

57-
## Shout out to the ⭐star gazers⭐ supporting the project
63+
## How to Contribute
64+
65+
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.
66+
67+
### Shout out to the ⭐star gazers⭐ supporting the project
68+
5869
[![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)
70+
71+
### Thanks for the forks🍴
72+
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)