Skip to content

Astro36/korean-school

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

100 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Korean School

Fetch Korean Schools Data Online

npm npm

ChangeLog

See CHANGELOG

Features

  • Find the school data by its location and name
  • Fetch the school information from School Info
  • Fetch the school meal from NEIS
  • Fetch the school schedule from Comcigan

Installation

  • Install with npm:
npm install korean-school --save
  • Clone the repo:
git clone https://github.com/Astro36/korean-school.git

Usage

API Documentation

See API

Example

Fetch the school daily meal:

const school = require('korean-school');
(async () => {
  const meal = await school.getMeal(school.find('경기도', '백석고'), new Date());
  if (meal !== null) {
    console.log(meal.breakfast);
    console.log(meal.lunch);
    console.log(meal.dinner);
  }
})();

License

KoreanSchool
Copyright (C) 2019  Seungjae Park

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

korean-school is licensed under the GPL 3.0.