Skip to content

Your AI assistant to assist you in working with documents, writing, summarizing and reminding you of forgettable steps while working in the documents

Notifications You must be signed in to change notification settings

j-deku/documindai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

13 Commits
Β 
Β 
Β 
Β 

Repository files navigation

🧠 AI Document Assistant

Your intelligent AI assistant for working with documents - helping you write better, summarize faster, and never forget important steps again.


✨ Overview

AI Document Assistant is a smart productivity platform designed to help individuals and teams work more efficiently with documents. It acts as a real-time assistant that supports users throughout their workflow.

The system focuses on reducing mental overhead by automating repetitive thinking tasks such as summarization, content generation, and step tracking β€” allowing users to focus on creativity and problem solving.


πŸš€ Key Features

  • πŸ“ Smart Writing Assistant
    Generate, rewrite, and improve text with AI-powered suggestions.

  • πŸ“š Document Summarization
    Convert long documents into clear, concise summaries.

  • πŸ” Key Insight Extraction
    Automatically identify important points and action items.

  • ⏰ Step Reminder System
    Get reminded of forgettable or critical steps while working.

  • πŸ€– Context-Aware AI
    Understands the document content and adapts responses accordingly.


πŸ› οΈ Tech Stack

Layer Technology
Frontend React
Backend Node.js, Express
AI Engine OpenAI / Custom NLP
Database MongoDB
Authentication JWT
Deployment Docker / Cloud

πŸ” Environment Variables

Create a .env file in the root directory:

OPENAI_API_KEY=your_api_key
DATABASE_URL=your_database_url
JWT_SECRET=your_secret_key

πŸ“¦ Installation & Setup

# Clone the repository
git clone https://github.com/your-org/documindai.git

# Navigate to project
cd documindai

# Install dependencies
npm install

# Start development server
npm run server

🧩 Project Structure

src/
 β”œβ”€β”€ controllers/     # Request handlers
 β”œβ”€β”€ services/        # Business logic
 β”œβ”€β”€ ai/              # AI logic and prompts
 β”œβ”€β”€ routes/          # API routes
 β”œβ”€β”€ middlewares/     # Auth & validation
 β”œβ”€β”€ apis             # API routes handler
 β”œβ”€β”€ utils/           # Helpers
 └── server.ts           # App entry point

πŸ§ͺ Example Use Cases

  • Students summarizing lecture notes
  • Developers generating documentation
  • Writers improving drafts
  • Teams tracking document workflows
  • Researchers extracting insights

πŸ“ˆ Roadmap

  • Real-time collaboration
  • Voice-to-document support
  • Browser extension
  • Offline mode

πŸ‘₯ Team

Name Role
Jeremiah Deku Backend Engineer / System Design
Francis Papafie Frontend Engineer
Hannah Odoi AI Engineer

🌟 Why This Project Matters

This project demonstrates real-world engineering skills:

  • AI system integration
  • Clean backend architecture
  • Scalable design patterns
  • Team-based development
  • Practical problem solving

It is built with production-level thinking, not just for academic purposes.


πŸ—οΈ System Architecture

Banner

About

Your AI assistant to assist you in working with documents, writing, summarizing and reminding you of forgettable steps while working in the documents

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors