Merge branch 'main' into feature/Milvus

# Conflicts:
#	packages/components/package.json

README.md

@@ -1,14 +1,25 @@
 <!-- markdownlint-disable MD030 -->
 
-# Flowise - LangchainJS UI
+<img width="100%" src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.png?raw=true"></a>
 
+# Flowise - Build LLM Apps Easily
+
+[![Release Notes](https://img.shields.io/github/release/FlowiseAI/Flowise)](https://github.com/FlowiseAI/Flowise/releases)
+[![Discord](https://img.shields.io/discord/1087698854775881778?label=Discord&logo=discord)](https://discord.gg/jbaHfsRVBW)
+[![Twitter Follow](https://img.shields.io/twitter/follow/FlowiseAI?style=social)](https://twitter.com/FlowiseAI)
+[![GitHub star chart](https://img.shields.io/github/stars/FlowiseAI/Flowise?style=social)](https://star-history.com/#FlowiseAI/Flowise)
+[![GitHub fork](https://img.shields.io/github/forks/FlowiseAI/Flowise?style=social)](https://github.com/FlowiseAI/Flowise/fork)
+
+English | [中文](./README-ZH.md)
+
+<h3>Drag & drop UI to build your customized LLM flow</h3>
 <a href="https://github.com/FlowiseAI/Flowise">
 <img width="100%" src="https://github.com/FlowiseAI/Flowise/blob/main/images/flowise.gif?raw=true"></a>
 
-Drag & drop UI to build your customized LLM flow using [LangchainJS](https://github.com/hwchase17/langchainjs)
-
 ## ⚡Quick Start
 
+Download and Install [NodeJS](https://nodejs.org/en/download) >= 18.15.0
+
 1. Install Flowise
     ```bash
     npm install -g flowise
@@ -19,16 +30,41 @@ Drag & drop UI to build your customized LLM flow using [LangchainJS](https://git
     npx flowise start
     ```
 
+    With username & password
+
+    ```bash
+    npx flowise start --FLOWISE_USERNAME=user --FLOWISE_PASSWORD=1234
+    ```
+
 3. Open [http://localhost:3000](http://localhost:3000)
 
 ## 🐳 Docker
 
+### Docker Compose
+
 1. Go to `docker` folder at the root of the project
-2. Create `.env` file and specify the `PORT` (refer to `.env.example`)
+2. Copy `.env.example` file, paste it into the same location, and rename to `.env`
 3. `docker-compose up -d`
 4. Open [http://localhost:3000](http://localhost:3000)
 5. You can bring the containers down by `docker-compose stop`
 
+### Docker Image
+
+1. Build the image locally:
+    ```bash
+    docker build --no-cache -t flowise .
+    ```
+2. Run image:
+
+    ```bash
+    docker run -d --name flowise -p 3000:3000 flowise
+    ```
+
+3. Stop image:
+    ```bash
+    docker stop flowise
+    ```
+
 ## 👨‍💻 Developers
 
 Flowise has 3 different modules in a single mono repository.
@@ -39,7 +75,7 @@ Flowise has 3 different modules in a single mono repository.
 
 ### Prerequisite
 
--   Install Yarn
+-   Install [Yarn v1](https://classic.yarnpkg.com/en/docs/install)
     ```bash
     npm i -g yarn
     ```
@@ -80,31 +116,57 @@ Flowise has 3 different modules in a single mono repository.
 
 6. For development build:
 
-    ```bash
-    yarn dev
-    ```
+    - Create `.env` file and specify the `PORT` (refer to `.env.example`) in `packages/ui`
+    - Create `.env` file and specify the `PORT` (refer to `.env.example`) in `packages/server`
+    - Run
+
+        ```bash
+        yarn dev
+        ```
 
     Any code changes will reload the app automatically on [http://localhost:8080](http://localhost:8080)
 
 ## 🔒 Authentication
 
-To enable app level authentication, add `USERNAME` and `PASSWORD` to the `.env` file in `packages/server`:
+To enable app level authentication, add `FLOWISE_USERNAME` and `FLOWISE_PASSWORD` to the `.env` file in `packages/server`:
 
 ```
-USERNAME=user
-PASSWORD=1234
+FLOWISE_USERNAME=user
+FLOWISE_PASSWORD=1234
 ```
 
+## 🌱 Env Variables
+
+Flowise support different environment variables to configure your instance. You can specify the following variables in the `.env` file inside `packages/server` folder. Read [more](https://github.com/FlowiseAI/Flowise/blob/main/CONTRIBUTING.md#-env-variables)
+
 ## 📖 Documentation
 
-Coming soon
-
-## 💻 Cloud Hosted
-
-Coming soon
+[Flowise Docs](https://docs.flowiseai.com/)
 
 ## 🌐 Self Host
 
+### [Railway](https://docs.flowiseai.com/deployment/railway)
+
+[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/pn4G8S?referralCode=WVNPD9)
+
+### [Render](https://docs.flowiseai.com/deployment/render)
+
+[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render)
+
+### [HuggingFace Spaces](https://docs.flowiseai.com/deployment/hugging-face)
+
+<a href="https://huggingface.co/spaces/FlowiseAI/Flowise"><img src="https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg" alt="HuggingFace Spaces"></a>
+
+### [AWS](https://docs.flowiseai.com/deployment/aws)
+
+### [Azure](https://docs.flowiseai.com/deployment/azure)
+
+### [DigitalOcean](https://docs.flowiseai.com/deployment/digital-ocean)
+
+### [GCP](https://docs.flowiseai.com/deployment/gcp)
+
+## 💻 Cloud Hosted
+
 Coming soon
 
 ## 🙋 Support
@@ -113,7 +175,14 @@ Feel free to ask any questions, raise problems, and request new features in [dis
 
 ## 🙌 Contributing
 
+Thanks go to these awesome contributors
+
+<a href="https://github.com/FlowiseAI/Flowise/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=FlowiseAI/Flowise" />
+</a>
+
 See [contributing guide](CONTRIBUTING.md). Reach out to us at [Discord](https://discord.gg/jbaHfsRVBW) if you have any questions or issues.
+[![Star History Chart](https://api.star-history.com/svg?repos=FlowiseAI/Flowise&type=Timeline)](https://star-history.com/#FlowiseAI/Flowise&Date)
 
 ## 📄 License