72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
# zyBooksBot
|
|
|
|
An automation bot for the zyBooks learning platform. Automatically complete Challenge Activities and Participation Activities with batch processing and real-time progress tracking.
|
|
|
|
## Features
|
|
|
|
- Automated completion for zyBooks Challenge and Participation Activities
|
|
- Batch processing for multiple chapters and sections
|
|
- Real-time progress tracking with detailed status
|
|
- Modern web interface with multi-select capabilities
|
|
- Stateless architecture supporting multiple users
|
|
- Robust error handling and recovery
|
|
|
|
## Quick Start
|
|
|
|
### Option 1: Docker (Recommended)
|
|
|
|
**Prerequisites:** Docker and Docker Compose
|
|
|
|
```bash
|
|
git clone https://git.qzydustin.com/qzydustin/zyBooksBot
|
|
cd zyBooksBot
|
|
docker-compose up -d
|
|
```
|
|
|
|
### Option 2: Local Development
|
|
|
|
**Prerequisites:** Node.js (v14+)
|
|
|
|
```bash
|
|
git clone https://git.qzydustin.com/qzydustin/zyBooksBot
|
|
cd zyBooksBot
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
Open http://localhost:3000 in your browser.
|
|
|
|
## Usage
|
|
|
|
1. Login with your zyBooks credentials
|
|
2. Select books and chapters
|
|
3. Use checkboxes for batch selection
|
|
4. Execute and monitor real-time progress
|
|
|
|
## Docker Commands
|
|
|
|
```bash
|
|
# Start the application
|
|
docker-compose up -d
|
|
|
|
# View logs
|
|
docker-compose logs -f
|
|
|
|
# Stop the application
|
|
docker-compose down
|
|
|
|
# Rebuild after code changes
|
|
docker-compose up --build -d
|
|
```
|
|
|
|
## Technical Details
|
|
|
|
**Stack:** Node.js, Express.js, JavaScript
|
|
**Communication:** HTTP API with Server-Sent Events
|
|
**Key Features:** Real-time streaming, frontend state management
|
|
**Deployment:** Docker containerized with health checks
|
|
|
|
## Important Notes
|
|
|
|
This tool is for educational purposes. Ensure compliance with your institution's academic integrity policies and zyBooks terms of service.
|