DocBrain UI

A modern, intuitive UI for interacting with your document knowledge bases

The official frontend for DocBrain - A powerful RAG framework for building AI applications with context-aware responses

Features • Getting Started • Usage • API Documentation • Contributing • License • Current Version

✨ Features

DocBrain UI is a powerful frontend application for managing and interacting with document knowledge bases:

• 🔐 User Authentication: Secure login and token-based authentication
• 📚 Knowledge Base Management: Create, view, and manage your knowledge bases
• 📄 Document Management: Upload, process, and organize documents within knowledge bases
• 👥 Role-Based Access Control: Manage user permissions with Owner, Admin, and User roles
• 🔄 Knowledge Base Sharing: Easily share knowledge bases with other users in your organization
• 🧠 Intelligent Query Routing: Automatic routing of questions to the appropriate data source
• ❓ Advanced Question Handling: Support for complex questions with optimized processing
• 💬 Conversational Interface: Chat with your documents using a natural language interface
• 🔍 Source Attribution: View the exact sources used to generate responses
• 📱 Responsive Design: Works seamlessly on desktop and mobile devices

🚀 Getting Started

Prerequisites

• Node.js (v18 or higher)
• npm or yarn
• A running instance of the DocBrain API server

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/DocBrain-UI.git
   cd DocBrain-UI

2. Install dependencies:

   npm install
   # or
   yarn install

3. Create a .env file in the root directory with the following content:

   VITE_API_URL=http://localhost:8000
   

   Replace the URL with your DocBrain API server address.

4. Start the development server:

   npm run dev
   # or
   yarn dev

5. Open your browser and navigate to http://localhost:5173

Building for Production

To build the application for production:

npm run build
# or
yarn build

The build artifacts will be stored in the dist/ directory.

📖 Usage

Authentication

1. Navigate to the login page
2. Enter your email and password
3. Upon successful authentication, you'll be redirected to the dashboard

Managing Knowledge Bases

1. Create a new knowledge base by clicking the "New Knowledge Base" button
2. Give your knowledge base a name and description
3. Upload documents to your knowledge base
4. Start chatting with your documents

Sharing Knowledge Bases

1. Select a knowledge base
2. Click the "Share" button in the knowledge base details page
3. Search for users by name or email
4. Click on a user to grant them access to your knowledge base
5. Manage existing shared users from the same interface

User Roles and Permissions

DocBrain UI implements a comprehensive role-based access control system:

• Owner: Has full access to all knowledge bases and can manage all users
• Admin: Has access to all knowledge bases and can manage regular users
• User: Has access only to their own knowledge bases and those shared with them

Chatting with Documents

1. Select a knowledge base
2. Type your question in the chat input
3. View the AI-generated response along with source attributions
4. Continue the conversation with follow-up questions

Advanced Question Features

1. Ask complex, multi-part questions for comprehensive answers
2. System automatically routes queries to the appropriate data source
3. View confidence scores and query classification for transparency
4. Receive query refinement suggestions for better results

📚 API Documentation

The DocBrain UI interacts with the DocBrain API. For detailed API documentation, see api.md.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

For more details, see our Contributing Guide.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

📦 Current Version

Current Version: v1.3.0

Latest release includes Advanced Question Handling, Query Routing, Improved Response Quality, and UI Enhancements.

For detailed release notes, see RELEASE_NOTES.md.

🙏 Acknowledgements

• React - A JavaScript library for building user interfaces
• TypeScript - Typed JavaScript at Any Scale
• Vite - Next Generation Frontend Tooling
• Tailwind CSS - A utility-first CSS framework
• Lucide Icons - Beautiful & consistent icons
• DocBrain - The backend RAG framework