Skip to content

comsaw/docs-summarizer

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

105 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docs Summarizer

A document summarization system built on the Koii network, designed to process and summarize documents efficiently.

Project Structure

The project consists of two main components:

  • worker/: The core processing component that handles document summarization tasks
  • planner/: Component responsible for task planning and coordination

Prerequisites

  • Node.js >= 18.17.0
  • Yarn package manager

Installation

  1. Clone the repository:
git clone [repository-url]
cd docs-summarizer
  1. Install dependencies:
yarn install

Development

Worker Component

The worker component is responsible for processing and summarizing documents. To run the worker:

cd worker
yarn install
yarn build
yarn start

Testing

Run tests for the worker component:

cd worker
yarn test

Configuration

The project uses configuration files for different environments:

  • config-task-test.yml: Test environment configuration
  • config-task-prod.yml: Production environment configuration

Dependencies

The project uses several key dependencies:

  • Koii network components (@_koii/*)
  • TypeScript for type safety
  • Webpack for bundling
  • Jest for testing

License

ISC

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 43.8%
  • TypeScript 36.8%
  • JavaScript 18.8%
  • Dockerfile 0.6%