The Ed-Fi Admin Console presents a graphical user interface (GUI) environment for managing deployments of the Ed-Fi ODS/API in multi-tenant environments.
The original source code was generously donated by the Texas Education Service Center Region 4.
This project is currently in alpha and under active development. Features and APIs are subject to change, and there may be bugs or incomplete functionality.
We welcome contributions and feedback, but please use this project at your own risk in environments. For more stable alternatives, consider waiting for a beta or stable release, scheduled in 1Q 2025.
Warning
NOT FOR PRODUCTION USE! Includes passwords in the default configuration that are visible in this repo and should never be used in real life. Be very careful!
- Follow the guide Docker Compose Test and Demonstration Configurations and run the script:
# Ignores the admin console image
./start-all-services-dev.ps1 $true- Open a terminal and install the dependencies using
npm i - Create a new file called
config.jsonbased onconfig.example.ports.json - Execute the command
npm run dev
The frameworks and libraries used are the following:
- React
- Typescript
- Vite (react-ts template)
- Chakra UI
Ed-Fi-Admin-Console/eng/docker-compose- sample setup for running the application locally.docs/- markdown-based developer documentationpublic- contains public/static assets (e.g. images)src- core source code
Copyright (c) 2025 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.