Welcome to the Teachfloor App Development documentation! This guide will help you build powerful extensions that integrate seamlessly with the Teachfloor platform.
Teachfloor Apps are extensions that enhance the platform's functionality by adding custom user interfaces, integrations, and workflows. Apps can:
- Display custom UI components in various locations throughout the dashboard
- Store and retrieve data securely
- Access platform resources through permissions
- Integrate with external services
- Enhance the learning experience for instructors and learners
- Introduction - Overview and concepts
- Quickstart Guide - Build your first app in 10 minutes
- App Manifest - Configure your app's metadata and capabilities
- Viewports System - Understand where apps can display
- Extension Kit Components - Use pre-built UI components
- Extension Kit Integration - Interact with the platform
- Data Storage - Persist user and app data
- Permissions - Request and use platform resources
- Deployment - Deploy private apps and publish to marketplace
- CLI Commands - Complete command reference
- Best Practices - Tips and patterns
- Examples - Sample apps and code snippets
- Troubleshooting - Common issues and solutions
Before you begin, ensure you have:
- Node.js 18.0.0 or higher
- npm or yarn package manager
- A Teachfloor account
- Basic knowledge of React and JavaScript
- Issues: GitHub Issues
- Email: [email protected]
This documentation is provided under the MIT License.
Ready to get started? Begin with the Introduction or jump straight to the Quickstart Guide!