NLUX
The Powerful Conversational AI
JavaScript Library β¨π¬
Docs Website | Discord Community | X
Do you like this project ? Please star the repo to show your support π π§‘
Building with NLUX ? Get in touch β We'd love to hear from you.
NLUX is React and JavaScript open-source library for building conversational AI interfaces. It makes it super simple
to build web applications powered by Large Language Models (LLMs). With just a few lines of code, you can add
conversational AI capabilities and interact with your favorite AI models.
Try NLUX π
Use nlux-cli to quickly spin up a new Next.js, React, or Vanilla TypeScript project with NLUX integrated.
Get started with NLUX and your favorite web framework under a minute:
# Next.js πΌ with NLUX
npx nlux-cli create next my-next-app# React βοΈ , Vite, with NLUX
npx nlux-cli create react my-react-app# Or, vanilla TypeScript π¨ , Vite, with NLUX
npx nlux-cli create vanilla my-vanilla-appDocs & Examples π₯
-
The docs website is available at:
docs.nlkit.com/nlux -
Several Get Started Guides are available, including for:
Next.js and Vercel AI β LangChain LangServe β React with Node.js Backend
Key Features π
- Build AI Chat Interfaces In Minutes β High quality conversational AI interfaces with just a few lines of code.
- React Components & Hooks β
<AiChat />for UI anduseChatAdapterhook for easy integration. - Next.js & Vercel AI β Out-of-the-box support, demos, and examples for Next.js and Vercel AI.
- React Server Components (RSC) and Generative UI π₯ β With Next.js or any RSC compatible framework.
- LLM Adapters β For
ChatGPTβLangChainπ¦LangServeAPIs βHugging Faceπ€ Inference. - A flexible interface to Create Your Own Adapter π― for any LLM β with support for stream or batch modes.
- Assistant and User Personas β Customize participant personas with names, images, and descriptions.
- Highly Customizable β Tune almost every UI aspect through theming, layout options, and more.
- Zero Dependency β Lightweight codebase β Core with zero dependency and no external UI libraries.
Repo Content π¦
This GitHub repository contains the source code for the NLUX library.
It is a monorepo that contains code for following NPM packages:
βοΈ React JS Packages:
@nlux/reactβ React JS components forNLUX.@nlux/langchain-reactβ React hooks and adapter for APIs created using LangChain's LangServe library.@nlux/openai-reactβ React hooks for the OpenAI API, for testing and development.@nlux/hf-reactβ React hooks and pre-processors for the Hugging Face Inference API@nlux/nlbridge-reactβ Integration withnlbridge, the Express.js LLM middleware by the NLUX team.
π¨ Vanilla JS Packages:
@nlux/coreβ The core Vanilla JS library to use with any web framework.@nlux/langchainβ Adapter for APIs created using LangChain's LangServe library.@nlux/openaiβ Adapter for the OpenAI API, for testing and development.@nlux/hfβ Adapter and pre-processors for the Hugging Face Inference API.@nlux/nlbridgeβ Integration withnlbridge, the Express.js LLM middleware by the NLUX team.
π Themes & Extensions:
@nlux/themesβ The defaultLunatheme and CSS styles.@nlux/markdownβ Markdown stream parser to render markdown as it's being generated.@nlux/highlighterβ Syntax highlighter based on Highlight.js.
Please visit each package's NPM page for information on how to use it.
Design Principles βοΈ
The following design principles guide the development of NLUX:
-
Intuitive β Interactions enabled by
NLUXshould be intuitive. Usage should unfold naturally without obstacles or friction. No teaching or thinking should be required to use UI built withNLUX. -
Performant β
NLUXshould be as fast as possible. Fast to load, fast to render and update, fast to respond to user input. To achieve that, we should avoid unnecessary work, optimize for performance, minimize bundle size, and not depend on external libraries. -
Accessible β UI built with
NLUXshould be accessible to everyone. It should be usable by people with disabilities, on various devices, in various environments, and using various input methods (keyboard, touch, voice). -
DX β
NLUXrecognizes developers as first-class citizens. The library should enable an optimal DX (developer experience). It should be effortless to use, easy to understand, and simple to extend. Stellar documentation should be provided. The feature roadmap should evolve aligning to developer needs voiced.
Mission π¨βπ
Our mission is to enable developers to build outstanding LLM front-ends and applications, cross platforms, with a focus on performance and usability.
Community & Support π
- Star The Repo π β If you like
NLUX, please star the repo to show your support.
Your support is what keeps this open-source project going 𧑠- GitHub Discussions β Ask questions, report issues, and share your ideas with the community.
- Discord Community β Join our Discord server to chat with the community and get support.
- docs.nlkit.com/nlux Developer Website β Examples, learning resources, and API reference.
License π
NLUX is licensed under Mozilla Public License Version 2.0 with restriction to use as
part of a training dataset to develop or improve AI models, or as an input for code
translation tools.
Paragraphs (3.6) and (3.7) were added to the original MPL 2.0 license.
The full license text can be found in the LICENSE file.
In a nutshell:
- You can use
NLUXin your personal projects. - You can use
NLUXin your commercial projects. - You can modify
NLUXand publish your changes under the same license. - You cannot use
NLUX's source code as dataset to train AI models, nor with code translation tools.
Wondering what it means to use software licensed under MPL 2.0? Learn more
on MPL 2.0 FAQ.
Please read the full license text in the LICENSE file for details.
About The Project π¨βπ»
This open-source project fits under the umbrella of NLKit, a suite of tools and libraries for
building conversational AI applications. NLUX is the first project in the NLKit suite, with more to come.
The project is being led by Salmen Hichri, a senior software engineer with over a decade of experience building user interfaces and developer tools at companies like Amazon and Goldman Sachs, and contributions to open-source projects.