@nlux/nlux

NLUX JS

@nlux/nlux is now @nlux/core

This package has been renamed to @nlux/core

Please visit @nlux/core package details page for more information.

---

Get Started With NLUX and ChatGPT 🚀

To get started with NLUX JS and ChatGPT, install the @nlux/core and @nlux/openai packages:

npm install @nlux/core @nlux/openai

Configure the OpenAI adapter with your API key:
(You can get an API key from your OpenAI dashboard)

import {createAiChat} from '@nlux/core';
import {createAdapter} from '@nlux/openai';

const chatGptAdapter = createAdapter()
    .withApiKey('YOUR_OPEN_AI_API_KEY')
    // 👇 Instruct ChatGPT how to behave (optional)
    .withSystemMessage(
        'Act as a Nobel Prize in Physics winner who is ' +
        'helping a PHD student in their research. Write short answers. Be funny!'
    );

Then render the AiChat component into your web page:

const aiChat = createAiChat()
    .withAdapter(chatGptAdapter)
    .withConversationOptions({
        scrollWhenGenerating: true,
    })
    .withPromptBoxOptions({placeholder: 'Ask me anything about nuclear physics!'});

aiChat.mount(document.getElementById('root'));

You should also include the NLUX theme CSS file in your HTML page.

And The Result Is ✨

A fully functional chatbot UI that can advise you on nuclear physics, coding, and even tell you a joke or two!

Theme File and CSS 🎨

You should include a theme CSS file into your HTML page.
You can download and host the Kensington Theme CSS file from @nlux/themes or use the CDN hosted version from below:

<link rel="stylesheet" href="https://themes.nlux.ai/v0.8.0/kensington.css"/>

This CDN is provided for demo purposes only and it's not scalable. Please download and host the theme files on your own for production use.

Docs Website 📖

Please visit docs.nlux.ai for the full documentation and examples.