Package Documentation
Independent npm packages for integrating EGW content into your own applications and workflows.
Available Packages
egw-writings-shared
Core database utilities
SQLite database interface, search functionality, and content retrieval methods.
egw-pdf-generator
PDF generation tools
Professional PDF generation with configurable formatting and copyright compliance.
egw-api-server
RESTful API server
Complete REST API for EGW content with search, filtering, and content endpoints.
egw-downloader
Content downloader
Download and manage EGW content with database setup and initialization tools.
egw-local-server
Development server
Local development server with hot reload and debugging capabilities.
Complete Documentation
Access the full package documentation with detailed installation instructions, API references, usage examples, and integration patterns for all available packages.
Quick Start Examples
Basic Database Search
import { EGWDatabase } from '@surgbc/egw-writings-shared';
const db = new EGWDatabase();
// Search for content
const results = db.search('salvation', 10, 0);
console.log(`Found ${results.length} results`);
// Get books
const books = db.getBooks('en');
console.log(`Available books: ${books.length}`);
// Clean up
db.close();
Generate PDF from Command Line
# Install globally
npm install -g @surgbc/egw-pdf-generator
# Generate PDF for book ID 1
egw-pdf-generator book --book-id 1 --output desire-of-ages.pdf
# Custom formatting
egw-pdf-generator book \
--book-id 1 \
--output custom-book.pdf \
--page-size A4 \
--font-family Times \
--font-size 12 \
--no-pagination
# List available books
egw-pdf-generator list-books --limit 10
Start API Server
# Start API server
egw-api-server start --port 3000 --cors
# Test endpoints
curl "http://localhost:3000/api/books?limit=5"
curl "http://localhost:3000/api/search?q=salvation&limit=10"
curl "http://localhost:3000/api/books/1/paragraphs?limit=50"
Integration Patterns
Web Application
Use the API server with any frontend framework to build custom EGW content applications.
- • React, Vue, Angular frontends
- • Mobile app backends
- • Progressive web apps
- • Content management systems
Automation & Scripts
Integrate packages into automation workflows for content processing and publishing.
- • Automated PDF generation
- • Content synchronization
- • Research compilation scripts
- • Backup and archival tools
Need Help?
GitHub Issues: Report bugs and request features at our GitHub repository
Discussions: Ask questions and share ideas in GitHub Discussions
Contributing: We welcome contributions! See our contributing guide for details.