1.2 KiB
1.2 KiB
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 tasksplanner/: Component responsible for task planning and coordination
Prerequisites
- Node.js >= 18.17.0
- Yarn package manager
Installation
- Clone the repository:
git clone [repository-url]
cd docs-summarizer
- 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 configurationconfig-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