Giter Club home page Giter Club logo

chatbot-ui's Introduction

Chatbot UI

This is forked from Chatbot UI, an open source chat UI for AI models.

Running Locally

Please make sure you update the node.js to the latest version.

1. Clone Repo

git clone https://github.com/shuminCA/chatbot-ui.git

2. Install Dependencies

npm i

3. Provide Pipeline Endpoint and Bearer Token

Create a .env.local file in the root of the repo with your pipeline endpoint and bearer token:

NEXT_PUBLIC_API_ENDPOINT=YOUR_ENDPOINT
NEXT_PUBLIC_BEARER_TOKEN=YOUR_TOKEN

4. Run App

There are two methods to run the application: using npm or Docker.

Using npm

To run the app with npm, execute the following command in your terminal:

npm run dev

This will start the application.

Using Docker

Alternatively, you can run the app using Docker. Follow these steps:

Screenshot 2023-12-19 at 12 04 05 PM

1. Create a docker image

Build a docker image by running the following command:

docker build .

2. Run the Docker Image

After you have successfully built the Docker image, you can run it using either its image ID or SHA256 digest.

docker run -p 3000:3000 {imageId/sha256}

Now you can run the chatbot at localhost:3000.

5. Use It

You should be able to start chatting. For better experience, please go to "Settings" -> "Theme" and select "light mode".

Customize UI

This interface allows users to personalize various aspects of their chatbot's appearance, including text elements and color schemes. Follow these steps to tailor your chatbot to your preferences.

Screenshot 2023-12-04 at 4 01 16 PM

1. Customizing Text Elements

You can modify the following text elements:

  • Chatbot Title
  • Chatbot Name

To make these changes:

  • Navigate to the root folder of your project.
  • Open the file named constants.config.js.
  • Edit the values as shown in the example below:
const CONSTANTS = {
    chatbotTitle: "Chatbot Title",
    chatbotName: "Chatbot Name",
};

module.exports = CONSTANTS;

2. Customizing Color Scheme

You can adjust the color schemes for:

  • Chatbot Name
  • Sidebar
  • Search Bar
  • Conversation Box

To customize the colors:

  • Go to the root folder of your project.
  • Open the file tailwind.config.js.
  • Locate the theme key and modify the color values under the colors and textColor sections as needed.

Here is an example:

// Additional code may be present above or below this snippet
  theme: {
    extend: {
      colors: {
        'sidebar': '#07224E',
        'conversation': '#53709E',
        'searchbar': '#141B38',
      },
      textColor: {
        'primary': '#1C3194',
      }
    },
  },
// Additional code may be present above or below this snippet

chatbot-ui's People

Contributors

mckaywrigley avatar shuminca avatar thomasleveil avatar nauxliu avatar bcullman avatar syedmuzamilm avatar chanzhaoyu avatar dotneet avatar dasunnimantha avatar liby avatar alanpog avatar riande avatar matriq avatar spctechdev avatar ryanhex53 avatar oznav2 avatar itbm avatar hyena459 avatar borborborja avatar adiestel avatar anthonypuppo avatar aweshchoudhary avatar ch4r4f avatar ernestobarrera avatar jdban avatar huuphongnguyen avatar srsholmes avatar shemarlindie avatar sonnylazuardi avatar regisrex avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.