Welcome to this open-source project dedicated to helping developers make API tools for student support service providers. The educational data ecosysem comprises primarily of SFTP servers and API calls to databases. The goal is to help student support service providers to gain access ecosystems and make sense of them all the data.
Because people looking at this repo has different levels of skill, this repository has a couple of ways to do that depending on your level of expertise and depending on your intended use.
If you are a student support service provider trying to use these tools, please read this documentation However, you will need to reach out to your LEA's Database Coordinator for the following information:
- API KEY
- Aeries School Code
- Target student's Aeries STU.ID field
- If you want to start off this project just learning the Python side of things, I suggest you start here
- If you want to understand how Fast API works in this project, I suggest you start here
- If you want to boot up a docker-less FastAPI/VUE.JS version of this project, I suggest you start here this format has FERPA related implications and should be used on local servers only.
- If you want to begin building a website that will pass the muster of FERPA and other Student Privacy laws, I suggest you start here
- If you want to dive into a demo version of aeries go here
- If you want to know about database standards used in this documentation go here
To get started, after cloning the repo locally:
$ cd LB_Community_Edition_Non_Enterprise/Pilot_Iteration_Files/gcc-iteration-nextjs
$ npm insatll
$ npm run dev
Take a look in your browser at http://localhost:3000/
