Teachfloor Apps

Welcome to the Teachfloor App Development documentation! This guide will help you build powerful extensions that integrate seamlessly with the Teachfloor platform.

What are Teachfloor Apps?

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

Documentation Structure

Getting Started

1. Introduction - Overview and concepts
2. Quickstart Guide - Build your first app in 10 minutes

Core Concepts

3. App Manifest - Configure your app's metadata and capabilities
4. Viewports System - Understand where apps can display
5. Extension Kit Components - Use pre-built UI components
6. Extension Kit Integration - Interact with the platform

Advanced Topics

7. Data Storage - Persist user and app data
8. Permissions - Request and use platform resources
9. Deployment - Deploy private apps and publish to marketplace

Reference

10. CLI Commands - Complete command reference
11. Best Practices - Tips and patterns
12. Examples - Sample apps and code snippets
13. Troubleshooting - Common issues and solutions

Prerequisites

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

Support

• Issues: GitHub Issues
• Email: support@teachfloor.com

License

This documentation is provided under the MIT License.

---

Ready to get started? Begin with the Introduction or jump straight to the Quickstart Guide!