From 30d3f6897d03027bed7ce2d729d967a3503cc3fd Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Tue, 19 Dec 2023 14:37:36 -0500 Subject: [PATCH] doc: backend dependency warning added --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c5919688..6a652207 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,10 @@ docker run -d -p 3000:8080 -e OLLAMA_API_BASE_URL=https://example.com/api --name While we strongly recommend using our convenient Docker container installation for optimal support, we understand that some situations may require a non-Docker setup, especially for development purposes. Please note that non-Docker installations are not officially supported, and you might need to troubleshoot on your own. +**Warning: Backend Dependency for Proper Functionality** + +In order to ensure the seamless operation of our application, it is crucial to run both the backend and frontend components simultaneously. Serving only the frontend in isolation is not supported and may lead to unpredictable outcomes, rendering the application inoperable. Attempting to raise an issue when solely serving the frontend will not be addressed, as it falls outside the intended usage. To achieve optimal results, please strictly adhere to the specified steps outlined in this documentation. Utilize the frontend solely for building static files, and subsequently run the complete application with the provided backend commands. Failure to follow these instructions may result in unsupported configurations, and we may not be able to provide assistance in such cases. Your cooperation in following the prescribed procedures is essential for a smooth user experience and effective issue resolution. + ### TL;DR 🚀 Run the following commands to install: