Welcome to the Platform Developer Console! We're so excited you're here. This is your one-stop shop for exploring, testing, and integrating with the Legends of Learning Developer Platform. Whether you're building your first educational app or enhancing an existing platform, we've got everything you need to create amazing learning experiences.
The Platform Developer Console is packed with powerful tools to help you build incredible educational applications. Here's what's waiting for you:
Create standards-aligned assignments that engage students and track their progress. Our interactive assignment builder makes it easy to:
- Build assignments aligned to specific learning standards
- Launch assignments directly to students
- View and manage all your assignments in one place
- Generate student join links with a single click
Seamlessly create and manage teacher and student accounts:
- Create teacher and student accounts with OAuth integration
- Generate secure login links for users
- View user details and activity
- Manage user relationships and permissions
Explore our vast library of educational content:
- Browse thousands of standards-aligned games, videos, and interactive learning experiences
- View detailed content information, reviews, and ratings
- Filter content by subject, grade level, and learning standards
- Preview content before assigning it to students
Find the perfect standards for your assignments:
- Browse comprehensive learning standards aligned to state and national frameworks
- Search standards by subject area and grade level
- Understand how content maps to specific standards
- Build assignments that perfectly match curriculum requirements
Find exactly what you need, fast:
- Search across educational content and standards
- Use advanced filtering to narrow down results
- Discover content by keyword, subject, or standard
- Get instant results with our optimized search engine
Get help when you need it:
- Chat with our AI assistant to explore Legends content
- Get guidance on building assignments
- Ask questions about API endpoints and integration patterns
- Receive code examples and best practices
See what's happening behind the scenes:
- Monitor all API calls in real-time
- View request and response details
- Debug integration issues with ease
- Track API usage and performance
Learn at your own pace:
- Explore API endpoints with live examples
- Access comprehensive API reference documentation
- View Swagger/OpenAPI specifications
- Get code samples and integration guides
Ready to dive in? Let's get you set up!
Before you begin, make sure you have:
- Node.js (v18 or later) - Download here
- npm or pnpm package manager
- Legends API credentials - You'll need an API key and secret from Legends of Learning
-
Clone the repository:
git clone https://github.com/LegendsOfLearning/platform-console.git cd platform-console -
Install dependencies:
npm install # or if you prefer pnpm pnpm install -
Configure your environment:
Create a
.envfile in the root directory with your API credentials:LEGENDS_API_KEY=your_api_key_here LEGENDS_API_SECRET=your_api_secret_here LEGENDS_API_URL=https://api.smartlittlecookies.com/api
-
Start the development server:
npm run dev # or pnpm dev -
Open your browser:
Navigate to
http://localhost:3000and you're ready to go! 🎉
We've designed every feature with developers in mind. The console provides:
- Interactive examples you can run right in your browser
- Real-time feedback on every API call
- Comprehensive error handling with helpful messages
- Beautiful, intuitive UI that makes complex tasks simple
Learn best practices through real examples:
- OAuth 2.0 authentication flows
- RESTful API design patterns
- Error handling and retry logic
- Rate limiting and performance optimization
Access thousands of educational resources:
- Games aligned to Common Core, NGSS, and state standards
- Videos covering K-12 curriculum
- Interactive learning experiences
- Content reviewed and rated by educators
platform-console/
├── src/
│ ├── app/ # Next.js app router pages
│ │ ├── assignments/ # Assignment management pages
│ │ ├── content/ # Content discovery pages
│ │ ├── users/ # User management pages
│ │ ├── standards/ # Standards browsing pages
│ │ ├── search/ # Search functionality
│ │ ├── chat/ # AI assistant chat
│ │ └── docs/ # Documentation pages
│ ├── components/ # React components
│ ├── lib/ # Utilities and API clients
│ └── contexts/ # React contexts
├── public/ # Static assets
├── docs/ # Additional documentation
│ └── api-documentation.md
└── package.json # Project dependencies
The assignment builder is where the magic happens. You can:
- Select learning standards from our comprehensive database
- Choose content that matches those standards
- Assign to specific students or groups
- Generate launch links instantly
- Track student progress and completion
Every API call you make is tracked and displayed in real-time. This helps you:
- Understand how the API works
- Debug integration issues
- Learn from example requests
- Optimize your API usage
Our content library includes:
- Educational Games: Engaging, standards-aligned games for K-12
- Videos: High-quality educational video content
- Interactive Experiences: Hands-on learning activities
- Reviews & Ratings: See what educators think about each piece of content
We're here to help you succeed! Here are some resources:
- API Documentation: Check out our comprehensive API documentation
- OpenAPI Spec: Explore the full API specification at https://api.smartlittlecookies.com/api/v3/docs/openapi
- In-App Chat: Use the AI assistant in the console for quick answers
- Support: Reach out to our developer support team for assistance
We love contributions! Here's how you can help:
-
Create a branch:
- For new features:
feat/your-feature-name - For bug fixes:
fix/your-fix-name
- For new features:
-
Make your changes:
- Follow TypeScript best practices
- Write tests for new features
- Update documentation as needed
- Follow the existing code style
-
Commit your changes:
feat(platform-console): add amazing new feature -
Push and create a pull request:
- Push your branch to GitHub
- Create a pull request with a clear description
- We'll review and provide feedback
- TypeScript: We use TypeScript for type safety
- Testing: Write tests for new features
- Documentation: Keep docs up to date
- Code Style: Follow existing patterns and conventions
- Accessibility: Ensure UI is accessible to all users
Once you're comfortable with the console, you can:
- Integrate the API into your own application
- Build custom workflows using our REST API
- Create educational experiences that engage students
- Scale your application with our robust infrastructure
- Join our developer community and share your creations
MIT License
Copyright (c) 2024 Legends of Learning
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Happy Building! 🎉 We can't wait to see what you create with the Legends of Learning Developer Platform. If you have questions, feedback, or just want to say hello, don't hesitate to reach out!