Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davideast/hnpwa-api
CDN cached Hacker News API
https://github.com/davideast/hnpwa-api
cloud-functions firebase hacker-news
Last synced: about 2 months ago
JSON representation
CDN cached Hacker News API
- Host: GitHub
- URL: https://github.com/davideast/hnpwa-api
- Owner: davideast
- Created: 2017-05-30T22:12:31.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-12-10T20:29:07.000Z (about 2 years ago)
- Last Synced: 2024-10-29T13:07:19.915Z (about 2 months ago)
- Topics: cloud-functions, firebase, hacker-news
- Language: TypeScript
- Homepage: https://api.hnpwa.com/v0/
- Size: 1020 KB
- Stars: 82
- Watchers: 6
- Forks: 2
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HNPWA API
Deploy a CDN cached Hacker News API to your own Firebase Hosting Domain. All in two lines of code 😎
**Heavily** inspired/guided by [cheeaun's](https://github.com/cheeaun) [node-hnapi](https://github.com/cheeaun/node-hnapi).
## Install
```bash
npm i hnpwa-api
```
## Basic usage
Import and use in your `functions/index.js` file:
```js
const hnapi = require('hnpwa-api');
exports.api = hnapi.trigger({
useCors: false, // defaults to false
useCompression: true, // defaults to true
browserCacheExpiry: 300, // in seconds (5 min is the default)
cdnCacheExpiry: 600, // in seconds (10 min is the default)
staleWhileRevalidate: 120, // Allow CDN to serve stale data 120 seconds after cdnCacheExpiry
firebaseAppName: 'hnpwa-api', // defaults to hnpwa-api
offline: false, // Serves offline data if data is downloaded (See Global Module guide)
routerPath: 'api', // provide a serving path ex: mysite.com/api/news.json
});
```
## Why?
Two reasons: **latency** and **same domain**.
### Latency
This API is designed for Firebase Hosting which is backed by a global CDN. Responses are cached in edges around the globe which results in low latency.
[Latency test: CDN cached vs. in memory cache](https://latency.apex.sh/?url=https%3A%2F%2Fhnpwa-api.firebaseapp.com%2Fnews.json%3Fpage%3D1&compare=https%3A%2F%2Fnode-hnapi.herokuapp.com%2Fnews%3Fpage%3D1)
### Same domain
With HTTP/2 you reuse one connection per domain. This package allows you to easily deploy your own HNAPI on your own domain for one nice TCP connection.
## Setup Tutorial
#### 1. Install the Firebase CLI:
```bash
npm i -g firebase-tools
```
#### 2. Initialize Cloud Functions for Firebase
```bash
firebase init functions
```
#### 3. Install hnpwa-api
Inside of the `functions` folder, install `hnpwa-api`:
```bash
cd functions
npm i hnpwa-api --save # not needed on npm 5 but you get what im sayin
```
#### 4. Add HNAPI endpoint
Open `functions/index.js`, and configure your HNAPI.
```js
const hnapi = require('hnpwa-api');
exports.api = hnapi.trigger({
useCors: false, // defaults to false
useCompression: true, // defaults to true
browserCacheExpiry: 300, // in seconds (5 min is the default)
cdnCacheExpiry: 600, // in seconds (10 min is the default)
staleWhileRevalidate: 120, // Allow CDN to serve stale data 120 seconds after cdnCacheExpiry
firebaseAppName: 'hnpwa-api', // defaults to hnpwa-api
offline: false, // Serves offline data if data is downloaded (See Global Module guide)
routerPath: 'api', // provide a serving path ex: mysite.com/api/news.json
});
```
#### 5. Initialize Firebase Hosting
```bash
firebase init hosting
```
#### 6. Create a redirect for the API function
Open `firebase.json` and create a redirect to call out to the HNAPI:
```json
{
"hosting": {
"public": "public",
"rewrites": [{
"source": "**",
"function": "api"
}]
}
}
```
#### 7. Deploy!
```bash
firebase deploy
```
That's all there is to it. Feel free to file an issue if you find a bug.
## Global Module use
The hnpwa-api module can either be downloaded as a global module or used from the
`node_modules/.bin/hnpwa-api` directory.
### Serving offline
The global module provides the ability to save data locally for offline serving. If
you're developing on a bus, airplane, or someother place without a connection you'll
need this.
```bash
# 1) Save to node_modules/hnpwa-api/offline (~10mb)
node_modules/.bin/hnpwa-api --save
# 2) Now serve offline
node_modules/.bin/hnpwa-api --serve --offline
```
## Non-Firebase setup
Not using Cloud Functions or Firebase Hosting as your backend? No problem. This library still has you covered.
```js
const hnapi = require('hnpwa-api');
// does not include any middleware like the trigger() call above
const expressApp = hnapi.app(); // optionally provide a firebase app name
expressApp.listen(3000, () => console.log('Listening all on my own!'));
```
This returns an express app instance with the expected HN API endpoints. No middleware is attached unlike the `trigger(config)` method.
### Why do I need a Firebase App Name if I'm not using Firebase Hosting?
You may not use Firebase as your backend, but Hacker News does. The base HN API is backed by the Firebase Database. This library uses the Firebase Node SDK to retrieve data and coalesce it into a single UI friendly response.
### Contribute!?
```bash
git clone https://github.com/davideast/hnpwa-api/
npm i
npm run build # single build of the project
npm run watch # typescript (tsc) watcher
npm run serve # local node debug server
npm run pack # local tarball for test installations
```