MarkMatute / ph-admin-data-divisions-crawler

a web crawler written in nodejs to get ph admin data divisions

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


ph-admin-data-divisions-crawler

minimalist typescript boilerplate
Explore the docs »

Getting Started

a web crawler built with nodejs, puppeteer to get latest data of PH admin divisions

Usage

  1. Clone repo

    git clone git@github.com:MarkMatute/ph-admin-data-divisions-crawler.git
    
  2. Check node version, current supported node version is NodeJs v16.17

    install via nvm if not yet available

    nvm install 16.17
    

    set node version to 16.17

    nvm use 16.17
    
  3. Install node modules

    npm install
    
  4. Build source

    npm run build
    
  5. Running development

    npm run dev
    
  6. Running docker development (Optional) Running with docker is optional and is only useful when building backend apis

    docker-compose up
    
  7. Running lint

    npm run lint
    
  8. Running prettier-format

    npm run prettier-format
    
  9. Running test

    npm run test
    
  10. Git commit triggers husky husky runs in the background the following command:

    npm run prettier-format && npm run lint && npm run test
    

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Mark Ernest R. Matute- linkedin - markernest.matute@gmail.com

(back to top)

About

a web crawler written in nodejs to get ph admin data divisions

License:MIT License


Languages

Language:TypeScript 95.3%Language:JavaScript 2.3%Language:Dockerfile 1.7%Language:Shell 0.8%