localpress v1.1.1

LocalPress

Overview

LocalPress is a command line tool to store your JSON APIs and images offline.

Example use cases

• You are running an API to feed data to the front-end of your application but the data does not change frequently (Blog, news, featured products, football results etc)

• You using a public API that has a daily request limit

• During development somebody is working on the backend constantly changing data and throwing syntax errors/debug statements

• Improve users performance and reduce server load. Do you really need to be pulling all that data from the database on every request?

Installation

LocalPress has only been tested in node v7 currently.

npm install -g localpress

Features

• Save JSON offline
• Save webpages offline organized by routes
• Parse images from JSON and save locally
• Routing to handle multiple paths

Options

Show version number

localpress -v
localpress --version

Show help

localpress -h
localpress --help

Configure

Params

• --url, -u (Required) - (URL of website with JSON data)
• --routes, -r (Optional) - (A comma separated list of routes) )

localpress configure
localpress c

URL Example (If no routes profided will default to the URL provided)

localpress config --url "http://mywebiste.com/api"

Routes Example

This example would configure: { home: 'http://mywebsite.com/api/', aboutUs: 'http://mywebsite.com/about-us' }

localpress config --url "http://mywebsite.com/api" --routes "home@/, aboutUs@/about-us"

Run

Params

• --url, -u (Optional) - (URL of website with JSON data - overrides config)
• --images, -i (Optional) - (Save images to local directory)
• --chunk, -c (Optional) - (Separate files by route prefix)

localpress run // will output a file named data.json

localpress run --chunk // will output two files home.json, aboutUs.json

localpress run --chunk --images // will output two files home.json, aboutUs.json and save images locally

Examples

Football API

Coming soon!