https://github.com/postlight/parser-api

🚀 A drop-in replacement for the Postlight Parser API.
https://github.com/postlight/parser-api

labs lambda lambda-functions mercury mercury-parser parser serverless

Last synced: 3 months ago
JSON representation

🚀 A drop-in replacement for the Postlight Parser API.

• Host: GitHub
• URL: https://github.com/postlight/parser-api
• Owner: postlight
• License: apache-2.0
• Created: 2019-02-06T00:40:06.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-09-29T13:49:13.000Z (about 2 years ago)
• Last Synced: 2024-04-16T01:05:54.500Z (7 months ago)
• Topics: labs, lambda, lambda-functions, mercury, mercury-parser, parser, serverless
• Language: JavaScript
• Homepage: https://reader.postlight.com/
• Size: 314 KB
• Stars: 282
• Watchers: 38
• Forks: 109
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# Postlight Parser API

[![Greenkeeper badge](https://badges.greenkeeper.io/postlight/parser-api.svg)](https://greenkeeper.io/)

This repo provides a drop-in replacement for the [Postlight Parser](https://github.com/postlight/parser) API.

In fact, this [AWS Lambda](https://aws.amazon.com/lambda/)-based API for running the Postlight Parser is the same code

and serverless infrastructure that powered the Postlight Parser API.

## Installation

```bash

# If you don't already have the Postlight Parser api installed, do that

git clone https://github.com/postlight/parser-api.git

# Install dependencies

yarn install

```

### API Gateway-like local dev server

To spin up a local dev server that will more closely match the API Gateway endpoint/experience:

```bash

yarn serve

```

## Deploy

Assuming you've already [set up your default AWS credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html#cli-quick-configuration) (or have set a different AWS profile via [the profile field](serverless.yml#L21)), simply run:

```bash

yarn deploy

```

`yarn deploy` will deploy to "dev" environment. You can deploy to `stage` or `prod`

with:

```bash

yarn deploy:stage

# -- or --

yarn deploy:prod

```

After you've deployed, the output of the deploy script will give you the API endpoint

for your deployed function(s), so you should be able to test the deployed API via that URL.

## License

Licensed under either of the below, at your preference:

- Apache License, Version 2.0

  ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

- MIT license

  ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

## Contribution

Unless it is explicitly stated otherwise, any contribution intentionally submitted for inclusion in the work, as defined in the Apache-2.0 license, shall be dual licensed as above without any additional terms or conditions.