Overview

This is the student backend server for VC Assist written in elixir

This project is in maintenance mode.

You're most likely looking for [vcassist/microservices/graph-scraper)(https://github.com/vc-assist/vcassist/tree/main/microservices/graph-scraper)

Features

• Sign in integration with learn.vcs.net and powerschool.vcs.net
• Full web scraping framework made from scratch
  • Automatic session and cookie handling
  • Automatic retries
  • Request pool
  • HTML parsing in rust
• Web scraping sutdent data (classes, grades, missing assignments, etc.)
• API for scraped student data
• Password encryption
• Grade calculator
• And more!

Quickstart

Install Elixir: https://elixir-lang.org/install.html

git clone https://github.com/vc-assist/backend.git # clone the repo

mix deps.get # install deps
mix ecto.setup # setup database
mix phx.server # start server

The server will start on http://localhost:4000

Interactive prompt: iex -S mix

Run unit test: mix test yourtestfile.exs

Routes

Current endpoints:

         stats_path  GET   /stats/active-count       VCAssistWeb.StatsController :active_count
        update_path  GET   /stats/update             VCAssistWeb.UpdateController :index
        update_path  POST  /stats/update-user        VCAssistWeb.UpdateController :update
  in_app_polls_path  GET   /polls/question           VCAssistWeb.InAppPollsController :get_question
  in_app_polls_path  GET   /polls/question/response  VCAssistWeb.InAppPollsController :get_responses
  in_app_polls_path  POST  /polls/question/response  VCAssistWeb.InAppPollsController :update
learn_vcs_auth_path  POST  /api/auth                 VCAssistWeb.LearnVCSAuthController :index
       feature_path  POST  /api/feature_update       VCAssistWeb.FeatureController :update_feature
  power_school_path  GET   /api/grades               VCAssistWeb.PowerSchoolController :grades
  power_school_path  GET   /api/hw_passes            VCAssistWeb.PowerSchoolController :hw_passes
  power_school_path  GET   /api/missing_assignments  VCAssistWeb.PowerSchoolController :missing_assignments
    grade_calc_path  POST  /grade_calc/calculate     VCAssistWeb.GradeCalcController :index
    grade_calc_path  POST  /grade_calc/category      VCAssistWeb.GradeCalcController :category
    grade_calc_path  POST  /grade_calc/reverse       VCAssistWeb.GradeCalcController :reverse_grade_calc
    grade_calc_path  GET   /grade_calc/classes       VCAssistWeb.GradeCalcController :classes
live_dashboard_path  GET   /dashboard                Phoenix.LiveView.Plug :home
live_dashboard_path  GET   /dashboard/:page          Phoenix.LiveView.Plug :page
live_dashboard_path  GET   /dashboard/:node/:page    Phoenix.LiveView.Plug :page