Skip to content

Spamziesagcan/EdgeScribe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

238 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EdgeScribe

EdgeScribe Logo

A modern web application for text summarization and translation powered by AI. EdgeScribe helps users quickly extract key information from large texts while offering optional translation services.

🌐 Live Demo

Visit the live application: https://edgescribe.pages.dev/

✨ Features

  • AI-Powered Summarization: Automatically condense large texts into concise, meaningful summaries
  • Multi-Language Translation: Translate summaries into your preferred language
  • Character Limit Management: Supports up to 5,000 characters with real-time validation
  • Request History: View your previous summarization requests with detailed metadata
  • API Status Monitoring: Real-time health checks and status updates
  • Responsive Design: Works seamlessly across desktop and mobile devices
  • Rate Limiting Protection: Built-in error handling for API limits and downtime

🚀 Getting Started

Prerequisites

  • Modern web browser with JavaScript enabled
  • Internet connection for API access

Installation

  1. Clone the repository:
git clone https://github.com/Spamziesagcan/EdgeScribe.git
cd EdgeScribe
  1. Open the project in your preferred development environment

  2. Serve the files using a local web server (e.g., Live Server extension in VS Code)

Deployment

This project is configured for deployment on Cloudflare Pages:

  1. Connect your GitHub repository to Cloudflare Pages
  2. Set the build output directory (if applicable)
  3. Deploy automatically on push to main branch

💡 Usage

  1. Enter Text: Paste or type your text into the input field (max 5,000 characters)
  2. Select Language: Choose your preferred translation language (optional)
  3. Submit: Click the submit button to generate summary and translation
  4. View Results: Review your summary and translation in the results section
  5. Check History: Browse previous requests in the history table

API Limitations

  • Maximum input: 5,000 characters per request
  • Rate limiting may apply during peak usage
  • API status is monitored and displayed in real-time

🛠️ Technology Stack

  • Frontend: HTML5, CSS3, JavaScript (ES6+)
  • Hosting: Cloudflare Pages
  • AI Integration: Text summarization and translation APIs
  • Architecture: Client-side application with API integration

📊 Features Overview

Summarization Engine

  • Extracts key sentences and main ideas
  • Maintains context and coherence
  • Configurable output length

Translation Service

  • Multi-language support
  • Preserves summary meaning and structure
  • Real-time translation processing

User Interface

  • Clean, intuitive design
  • Real-time character counting
  • Status indicators and error handling
  • Responsive layout for all devices

🔧 Configuration

The application includes built-in configuration for:

  • API endpoints and authentication
  • Character limits and validation
  • Error handling and retry logic
  • UI preferences and themes

📈 Performance Metrics

The application tracks:

  • Request processing time
  • Character count per request
  • API response status
  • Error rates and types

🤝 Contributing

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

📝 License

This project is open source. Please check the repository for license details.

🐛 Issues and Support

If you encounter any issues or have questions:

  1. Check the Issues page
  2. Create a new issue with detailed description
  3. Include browser information and error messages

🚀 Roadmap

  • Bulk text processing
  • Additional language support
  • Export functionality (PDF, TXT)
  • User accounts and saved preferences
  • Advanced summarization options
  • Integration with popular document formats

📞 Contact

For questions or suggestions, please open an issue on GitHub.


EdgeScribe - Making text summarization and translation accessible to everyone. hi

About

EdgeScribe is a versatile tool designed for efficient edge-based text annotation and processing. It provides streamlined methods for labeling, analyzing, and managing textual data at the edges of various data structures, making it ideal for natural language processing and machine learning.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors