ashaindlin / better-tms

A parser/scraper/API thing for Drexel’s WebTMS

Nie pracuje się już nad nim/nie jest aktywnie utrzymywany.

get started

  1. clone the repo
  2. run npm install to fetch the dependencies
  3. optionally, choose a port to run on with export PORT=1234 (with the port ofyour choice)
  4. start with node app.js

for users: api endpoints

Returns a JSON object with term numbers as keys and English representations ofterm names as values. Przykład:

GET /terms{ "1": "Fall Quarter 13-14", "2": "Winter Quarter 13-14", "3": "Spring Quarter 13-14", ... "13": "Spring Semester 14-15", "14": "Summer Semester 14-15"}

/courses

Zwraca obiekt JSON zawierający wszystkie kursy pasujące do zapytania, indeksowane liczbami całkowitymi zaczynającymi się od 0.

Ciąg zapytania do courses musi zawierać term (indeks z datareturned by the /terms route) oraz jedno z następujących: name (ciąg do wyszukiwania w nazwach kursów), number (liczba do dokładnego dopasowania) lub crn (aCRN do dokładnego dopasowania).

W przyszłości będzie można wyszukiwać wszystkie zajęcia oferowane w danym semestrze.

dla programistów: struktura kodu

  • app.js: Główny punkt wejścia do aplikacji. Tutaj definiuje się trasy Express i wybiera port, na którym będą nasłuchiwane żądania.
  • form.js: Pusty formularz wyszukiwania, funkcja pozwalająca uzyskać jego zmodyfikowaną wersję oraz adres URL, na który należy go wysłać, są przechowywane w tym miejscu.
  • package.json: To, co zwykle (zależności, numer wersji itp.).
  • README.md: Ten plik.
  • courses.js: Większość logiki aplikacji, w tym wszystkie ważnegetCourses funkcje.
  • terms.js: Pobierz listę wszystkich terminów, indeksowanych według numerów.

.

Leave a Reply