Awesome Ed-Fi Prompts 🚀

A curated library of AI coding assistant prompts specifically designed for building Ed-Fi integrations. This repository serves as a community-driven resource to help developers leverage AI tools effectively when working with Ed-Fi APIs and data standards.

🤝 Contributing

We encourage and welcome contributions from the Ed-Fi community! Whether you're a developer, integration specialist, or AI enthusiast, your prompts can help others build better Ed-Fi integrations.

How to Contribute

1. Fork this repository
2. Create a new branch for your contribution
3. Use the submission template to structure your prompt
4. Place your prompt in the appropriate directory:
   • prompts/ods-api/ - For Ed-Fi ODS/API integrations
   • prompts/admin-api/ - For Ed-Fi Admin API integrations
   • prompts/analytics/ - For Ed-Fi Analytics and reporting
   • prompts/other/ - For other Ed-Fi-related integrations
5. Submit a pull request with a clear description of your prompt

What Makes a Good Prompt?

• Specific to Ed-Fi: Focus on Ed-Fi APIs, data models, or integration patterns
• Clear Requirements: Include detailed technical specifications and expected outcomes
• Contextual: Provide background information and Ed-Fi resource references
• Tested: Ideally, test your prompt with an AI assistant before submitting
• Well-Documented: Include examples, sample data, and clear instructions

📋 Submission Template

Before submitting a new prompt, please use our submission template to ensure consistency and completeness. The template includes:

• Structured format for requirements and specifications
• Guidelines for file naming and organization
• Review process information
• Best practices for prompt creation

📚 Table of Contents

Ed-Fi ODS/API Integrations

• Student Enrollment Integration - Python application for managing student enrollment data through the Ed-Fi ODS/API

Ed-Fi Admin API Integrations

• School Management Integration - Node.js application for managing educational organizations and API configurations

Analytics and Reporting

Coming soon! Contribute your analytics-focused prompts.

Other Ed-Fi Integrations

Coming soon! Share your creative Ed-Fi integration prompts.

🎯 Example Prompts

This repository includes two comprehensive example prompts to demonstrate the level of detail and structure we recommend:

1. Ed-Fi ODS/API Student Enrollment Integration

A detailed prompt for creating a Python application that handles student enrollment workflows using the Ed-Fi ODS/API. Includes authentication, data validation, error handling, and monitoring requirements.

2. Ed-Fi Admin API School Management Integration

A comprehensive prompt for building a Node.js application that manages educational organizations, applications, and API client configurations through the Ed-Fi Admin API.

🔧 Using These Prompts

1. Choose a relevant prompt from the table of contents
2. Review the requirements and adapt them to your specific needs
3. Copy the prompt to your AI coding assistant (ChatGPT, Claude, Copilot, etc.)
4. Iterate and refine the generated code based on your environment
5. Share improvements back to the community via pull requests

📖 Ed-Fi Resources

• Ed-Fi Alliance Homepage
• Ed-Fi ODS/API Documentation
• Ed-Fi Data Model
• Ed-Fi Community Hub
• Ed-Fi GitHub Organization

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

🌟 Acknowledgments

• Ed-Fi Alliance for creating and maintaining the Ed-Fi standards and APIs
• The Ed-Fi community for their contributions and feedback
• AI tool creators for making these integrations more accessible

---

Ready to contribute? Start by reviewing our submission template and sharing your Ed-Fi AI prompts with the community!