Currig is an AI Application Developed by I and my team for Educators in Sub Sahara Africa
{
const data = JSON.parse(event.data);
if (data.content) {
console.log(data.content);
}
};
```
## Usage
### Getting Started
1. Visit the application landing page
2. Click "Get Started" to access the dashboard
3. Complete the quick onboarding (optional) to personalize recommendations
4. Choose a tool:
- **Lesson Plan**: Create structured lesson content
- **Quiz Generator**: Build assessment tools
- **AI Copilot**: Ask teaching questions
### Creating a Lesson Plan
1. Navigate to the Lesson Plan tool
2. Expand "Customize Lesson Plan" for advanced options
3. Enter your topic or upload relevant content
4. Specify grade level, duration, and standards
5. Click send to generate
### Generating a Quiz
1. Go to the Quiz Generator
2. Configure difficulty, question count, and types
3. Provide lesson content via text, file, or YouTube
4. Click send to generate
### Using the AI Copilot
1. Access the AI Copilot
2. Type your teaching question or upload materials
3. Receive instant advice with suggestions and follow-up questions
4. Use the streaming option for real-time responses
## Configuration
### Environment Variables
```env
# Backend Configuration
FASTAPI_ENV=production
LOG_LEVEL=INFO
# LLM Configuration
LLM_API_KEY=your_api_key
LLM_MODEL=your_model_name
# ASR Configuration
ASR_MODEL=your_asr_model
SUPPORTED_LANGUAGES=hausa,igbo,yoruba,english
# CORS Settings
ALLOWED_ORIGINS=
http://localhost:3000,https…
```
## Development
### Adding a New Feature
1. Create the feature module in `backend/src/api/`
2. Add the API route in `router.py`
3. Create the frontend interface in `frontend/js/pages/`
4. Update navigation in `frontend/js/components/navigation.js`
5. Add styling in `frontend/css/pages.css`
### Testing the API
Use curl or Postman to test endpoints:
```bash
# Test health check
curl
localhost
# Test lesson plan generation
curl -X POST
localhost \
-H "Content-Type: application/json" \
- …