Project Meadowlark is a research and development effort to explore potential for use of new technologies, including managed cloud services, for starting up a "cloud native" Ed-Fi compatible API.
While it was originally intended as a proof-of-concept, it is now moving toward production readiness. Milestone 0.3.0 has been released with Docker and real OAuth2 support. Next steps will be to take feedback from pilot tests, flesh out the PostgreSQL support, tune performance, and work toward full streaming support.
See Project Meadowlark - Exploring Next Generation Technologies in Tech Docs for more information on the background and design decisions for this project.
- Running on Localhost
- Configuration
- Developer getting started notes
- Additional technical details
- How to Submit an Issue (Tech Docs)
- How Submit a Feature Request (Tech Docs)
You may be asking yourself, "where are the instructions for cloud deployment?" We're working on it. Milestone 0.1.0 had severless deploy to AWS built-in, but there were several aspects that no longer fit well with our refined strategy in milestone 0.2.0, so the current release does not have any intrinsic cloud deployment support. The upcoming 0.3.0 release will have basic deployment capabilities on Azure, the preferred platform for our first pilot project.
The Ed-Fi Alliance welcomes code contributions from the community. Please read the Contributor's Guide for detailed information on how to contribute source code.
Looking for an easy way to get started? Review Meadowlark up-for-grabs tickets for a list of useful tickets that are currently of low priority to the core development team, and thus won't be addressed in upcoming sprints.
Copyright (c) 2023 Ed-Fi Alliance, LLC and contributors.
Licensed under the Apache License, Version 2.0 (the "License").
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
See NOTICES for additional copyright and license notifications. See CONTRIBUTORS for a list of external contributors to the project.
Meadowlark image: Copyright © Joel Chamberlain, some rights reserved. Original source.