https://github.com/niawjunior/docaider
Describe your data in plain language. We’ll turn it into stunning, interactive charts – automatically.
https://github.com/niawjunior/docaider
ai-sdk mcp text-to-visualization
Last synced: 3 months ago
JSON representation
Describe your data in plain language. We’ll turn it into stunning, interactive charts – automatically.
- Host: GitHub
- URL: https://github.com/niawjunior/docaider
- Owner: niawjunior
- Created: 2025-05-01T14:22:29.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-07-04T09:57:16.000Z (3 months ago)
- Last Synced: 2025-07-04T10:39:04.328Z (3 months ago)
- Topics: ai-sdk, mcp, text-to-visualization
- Language: TypeScript
- Homepage: https://www.docaider.com
- Size: 3.49 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DocAider
An AI-powered Knowledge Management and Retrieval-Augmented Generation (RAG) system that helps users build, manage, and query their knowledge base using natural language processing and semantic search.
## Features
- 🔍 **Semantic Search**: Find relevant information using natural language queries or keywords
- 🤖 **AI-Powered Knowledge Retrieval**: Get AI-generated answers from your document repository
- 🏷️ **Smart Knowledge Organization**: Automatically process and structure information from documents
- 📊 **Knowledge Analytics**: Track usage and identify gaps in your knowledge base
- 🔄 **Context-Aware Responses**: Understands technical jargon and domain-specific terminology
- 🔐 **Secure & Private**: Enterprise-grade security with role-based access control
- 🚀 **Fast & Scalable**: Built for performance with efficient vector search capabilities
## Key Features
### 1. Document Analysis & Q&A
- **Ask Questions**: Get precise answers from your uploaded documents
- **Semantic Search**: Find relevant information using natural language queries
- **Document Management**: View and organize all your uploaded documents in one place
- **Context-Aware Responses**: AI understands document context for accurate answers
### 2. Knowledge Base Creation
- **Document Processing**: Upload and process various document formats (PDF, CSV, TXT, DOCX)
- **Knowledge Extraction**: Automatically extract key information from documents
- **Knowledge Organization**: Structure and categorize information for efficient retrieval
- **Multilingual Support**: Process and understand documents in multiple languages
### 3. Retrieval-Augmented Generation
- **Contextual Responses**: Generate responses based on your knowledge base
- **Source Attribution**: Identify which documents provided the information
- **Confidence Scoring**: Understand the reliability of generated responses
- **Knowledge Gaps Identification**: Identify areas where more information is needed
### 4. Vector Database Integration
- **Efficient Storage**: Store document embeddings for fast retrieval
- **Semantic Matching**: Match queries to the most relevant document sections
- **Scalable Architecture**: Handle growing knowledge bases with ease
- **Real-time Updates**: Update knowledge base with new information seamlessly
### 5. Knowledge Analytics
- **Usage Insights**: Track which documents are most frequently queried
- **Knowledge Coverage**: Identify strengths and gaps in your knowledge base
- **Query Patterns**: Understand what information users seek most often
- **Performance Metrics**: Monitor response quality and retrieval accuracy
## Tech Stack
- **Frontend**: Next.js 15.3 with TypeScript
- **UI Components**: Tailwind CSS, Shadcn UI
- **AI/ML**: OpenAI Embeddings, Vector Search
- **Backend**: Next.js API Routes
- **Database**: Vector Database (Supabase)
- **Authentication**: Supabase Auth
- **Icons**: React Icons
## Getting Started
### Prerequisites
- Node.js 18 or higher
- npm or yarn package manager
- OpenAI API key (for embeddings and AI features)
- Supabase account (for vector database and authentication)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/niawjunior/docaider.git
cd docaider
```
2. Install dependencies:
```bash
npm install
# or
yarn
```
3. Set up environment variables:
```bash
cp .env.example .env.local
```
4. Configure your `.env.local` file:
```env
NEXT_PUBLIC_SITE_URL=
NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
OPENAI_API_KEY=
```
5. Run database migrations (if applicable)
6. Start the development server:
```bash
npm run dev
# or
yarn dev
```
6. Open [http://localhost:3000](http://localhost:3000) in your browser
## Project Structure
```
docaider/
├── app/ # Next.js 13+ app directory
│ ├── api/ # API routes
│ ├── components/ # Reusable React components
│ ├── lib/ # Utility functions and configurations
│ ├── models/ # Data models and types
│ └── services/ # Business logic and API clients
├── public/ # Static assets
├── styles/ # Global styles
└── types/ # TypeScript type definitions
```
## Development
### Development Server
```bash
npm run dev
# or
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### Building for Production
```bash
npm run build
# or
yarn build
```
### Running Tests
```bash
npm test
# or
yarn test
```
## Deployment
This project is optimized for deployment on Vercel. To deploy:
1. Push your changes to your Git repository
2. Connect your repository to Vercel
3. Set up the required environment variables in the Vercel dashboard
4. Deploy!
For other deployment options, refer to the [Next.js deployment documentation](https://nextjs.org/docs/deployment).
## Contributing
We welcome contributions! Here's how you can help:
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/your-feature`)
3. Commit your changes (`git commit -m 'Add your feature'`)
4. Push to the branch (`git push origin feature/your-feature`)
5. Open a Pull Request
Please make sure to update tests as appropriate and follow the existing code style.
### Code Style
- Use TypeScript for type safety
- Follow the existing component structure
- Write meaningful commit messages
- Add appropriate test coverage
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Support
For support, please:
1. Check the [GitHub Issues](https://github.com/niawjunior/docaider/issues) for existing solutions
2. Open a new issue if you don't find an answer
3. Include detailed reproduction steps and environment information
## Acknowledgments
- Built with [Next.js](https://nextjs.org/)
- Powered by [OpenAI](https://openai.com/)
- UI components from [shadcn/ui](https://ui.shadcn.com/)