/sunrin-meal

Backend for Android & Django Project @sunrin-internet-highschool

Primary LanguageTypeScript

MealAPI

IamSchool API Parser for Android & Django Project at Sunrin Internet High School

Yarn Scripts

Install dependencies :

yarn

Serve with Hot Reload :

yarn serve

Bundle for Production via Webpack :

yarn build

Run Deployment Automation :

yarn deploy

Stop Deployment :

yarn stop

Environment Setup (.env)

HTTP_HOST=(localhost for default)
HTTP_PORT=(80 for default)
HTTPS_HOST=(localhost for default)
HTTPS_PORT=(443 for default)

Express Routes

  • /

    • Executes getRecentMeal()
    • Returns Yesterday, Today, Tomorrow Meal
    • Also returns "급식 없음" if meal not served

  • /raw

    • Executes getRawMeal()
    • Returns raw HTML meal data for Apple Shortcuts
    • Includes allergic food Info

  • /monthly

    • Executes getMonthlyMeal()
    • Returns Meal of the Month

  • /monthly/YYYY-DD

    • Executes getMonthlyMeal() with client parameters
    • Returns meal object corresponding to client parameters

  • /fetch

    • Executes async function fetchMeal()
    • Manually fetches meal
    • Returns ALL of the meals so far (including images)

  • /cache

    • Executes returnCache()
    • Returns cache

  • /allergy

    • Returns Allergic Food Info

Express Routes (Android Java Support)

  • /J

    • Executes JgetRecentMeal()
    • Returns Yesterday, Today, Tomorrow Meal
    • Also returns "급식 없음" if meal not served

  • /Jmonthly

    • Executes JgetMonthlyMeal()
    • Returns Meal of the Month

  • /Jmonthly/YYYY-DD

    • Executes JgetMonthlyMeal() with client parameters
    • Returns meal object corresponding to client parameters