Skip to content

Macpickle/Katilixs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Katilix

Revolutionary Focus Tool - A Chrome Extension with AI-powered assistance for users with disabilities.

Project Structure

This repository contains two main components:

Extension (Frontend)

A Chrome Extension built with React and Vite that provides:

  • Disability Support: Customizable tools and recommendations based on user needs (Dyslexia, ADHD, etc.)
  • Usage Tracker: Monitor time spent on different websites
  • AI Assistant: Page summarization and Q&A capabilities powered by Google Gemini

Server (Backend)

An Express.js API server with Azure integration that provides:

  • AI Services: Summarization and Q&A endpoints using Google Generative AI
  • Usage Tracking: Store and retrieve user activity statistics
  • User Preferences: Save and manage user disability settings

Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn
  • Chrome browser (for extension testing)

Installation

  1. Clone the repository:
git clone <repository-url>
cd katilix-repo
  1. Install dependencies for both extension and server:
npm install

Or install separately:

cd extension && npm install
cd ../server && npm install

Development

Extension

cd extension
npm run dev

Server

cd server
npm run dev

Environment Setup

  1. Create a .env file in the server/ directory (you can copy from .env.example if it exists):
PORT=3000
NODE_ENV=development
CORS_ORIGIN=http://localhost:5173
GEMINI_API_KEY=your_gemini_api_key
AZURE_SQL_SERVER=your_server.database.windows.net
AZURE_SQL_DATABASE=katilix_db
AZURE_SQL_USER=your_username
AZURE_SQL_PASSWORD=your_password
  1. Replace placeholder icon files in extension/public/icons/ with actual PNG images:
    • icon16.png (16x16 pixels)
    • icon48.png (48x48 pixels)
    • icon128.png (128x128 pixels)

Features

  • Disability Support: Personalized recommendations and tools
  • Usage Tracking: Monitor and visualize website usage
  • AI-Powered Summarization: Get quick summaries of web pages
  • Interactive Q&A: Ask questions about page content

License

[Add your license here]

About

Revolutionary Focus Tool

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors