chrsep/vor repository overview

⁠(WIP) Vor

Backend for obserfy. A web-based tool for managing student information for Montessori Schools. Currently this tools focuses on pre-school's needs.

⁠Early Access MVP

Hosted version is available on https://obserfy.com⁠ for you to try. It is currently provided for free until we consider it as feature complete. Keep in mind that the software is currently still in early preview.

If you were to try, we would love to hear any of your feedback through the chat, github issue, or email at [email protected]⁠.

⁠Goals

1. Make it easy for teachers to observe, track and understand their students.
2. Speed up teacher on-boarding.
3. Reduce the teacher's paperwork burden so that they can focus on the more important things.

⁠Planned Features

• Record observations
• Track student progress on Montessori curriculum
• Analyze data
• Prepare reports

⁠How to run

1. generate ssl certificate for postgres
   • cd docker/posgres/ssl
   • ./generate.sh
2. go back to project root and run docker compose, this will run the API server
   • cd ../../../
   • docker-compose up -d
3. go to frontend, install dependencies and run gatsby.
   • cd frontend
   • yarn
   • yarn develop

Gatsby would be running on https://localhost:8001⁠, with the /api proxied to http://localhost:8000⁠.

You can import insomnia.json to insomnia to use Insomnia for debugging the API server running on http://localhost:8000⁠. The API server runs inside a docker container complete with auto-reload on file changes and delve for debugging.