Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.39 KB

README.md

File metadata and controls

45 lines (32 loc) · 1.39 KB
Raw

Postlight Parser API

License: MIT

A RESTful API wrapper for the Postlight Parser library. The API allows you to extract content and metadata from any webpage by simply sending a GET request with the URL of the page you want to parse.

Getting Started

Prerequisites

You'll need to have the following installed on your machine:

Installation

  1. Clone this repository:
git clone https://github.com/GoodMorningTech/parser
  1. Install dependencies
cd parser
npm install

Usage

You can start the server locally with:

node index.js

The API is now available at http://localhost:3000. To parse a webpage, send a GET request to the /parse endpoint, passing the URL of the page as a query parameter:

GET http://localhost:3000/parse?url=<url-to-parse>

The response will be a JSON object containing the extracted content and metadata.

Contributing

Contributions are welcome! If you have an idea for a new feature or find a bug, please open an issue. If you want to contribute code, please fork the repository and submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.