https://github.com/simonbetton/ratesapi.nz

Free OpenAPI service to retrieve the latest lending rates offered by NZ Institutions
https://github.com/simonbetton/ratesapi.nz

api banking bun cloudflare-workers hono interest-rates

Last synced: 12 days ago
JSON representation

Free OpenAPI service to retrieve the latest lending rates offered by NZ Institutions

• Host: GitHub
• URL: https://github.com/simonbetton/ratesapi.nz
• Owner: simonbetton
• License: mit
• Created: 2024-02-20T02:21:17.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T22:04:21.000Z (15 days ago)
• Last Synced: 2024-10-22T09:53:22.310Z (15 days ago)
• Topics: api, banking, bun, cloudflare-workers, hono, interest-rates
• Language: TypeScript
• Homepage: https://ratesapi.nz
• Size: 463 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        





  Rates API





  ✨ https://ratesapi.nz ✨

  


  Rates API is a free OpenAPI service to retrieve the latest lending rates offered by New Zealand financial institutions – updated hourly.








  





  Setup

    •  

  GitHub

    •  

  Documentation






This project uses [Bun](https://bun.sh/), [Hono](https://hono.dev/) and [Cloudlfare Workers](https://workers.cloudflare.com/).

Cloudflare Workers is a JavaScript edge runtime on Cloudflare CDN.

You can develop the application locally and publish it with a few commands using [Wrangler](https://developers.cloudflare.com/workers/wrangler/).

Wrangler includes a transcompiler, so we can write directly in TypeScript.



## Setup

#### 📦 Install dependencies

```zsh

bun i

```

#### 🏗️ Run locally

Run the development server locally. Then, access `http://localhost:8787` in your web browser.

```zsh

bun run dev

```

#### 🚀 Deploy to Cloudflare Workers

```zsh

bun run deploy

```