RAGMan frontend is a fork of ChatBot-UI at around Nov 8, 2023, which is further developed by the Mondego group at UC Irvine. Our project is a true fork, in the sense that it does not follow ChatBot-UI any longer. Our UI aims to be feature poor and very simple. Unlike the original ChatBot-UI, RAGMan frontend requires a second web app, RAGMan-backend, to work. All the fancy intelligent actions are done in RAGMan-backend.
NOTE: requires NodeJS version 18 or above.
1. Clone Repo
git clone https://github.com/Mondego/ragman-frontend.git2. Install Dependencies
npm i3. Provide OpenAI API Key
Create a .env.local file in the root of the repo with your OpenAI API Key: (This step is unnecessary, because we call openai API from backend, but you can set the key to make sure the frontend is running)
OPENAI_API_KEY=YOUR_KEYYou can set
OPENAI_API_HOSTwhere access to the official OpenAI host is restricted or unavailable, allowing users to configure an alternative host for their specific needs.
Additionally, if you have multiple OpenAI Organizations, you can set
OPENAI_ORGANIZATIONto specify one.
4. Run App
-
run locally
npm run dev
-
use this command for server running
npm run dev -- -p 3333
5. Use It
You should be able to start chatting.
When deploying the application, the following environment variables can be set:
| Environment Variable | Default value | Description |
|---|---|---|
| RAGMAN_BACKEND_HOST | http://localhost:5000 | The url for the server |
| RAGMAN_API_KEY | 123 | Eventually, we'll implement this... |
| NEXT_PUBLIC_NAME | The user-facing name of the app | |
| NEXT_PUBLIC_MAX_LENGTH | 1000 | The maximum number of characters the user can send in a message |
| NEXT_PUBLIC_COMMENT_MAX_LENGTH | 1000 | The maximum number of characters the user can enter in a comment |
If you have any questions, feel free to reach out to Iris Ma on Iris Ma.