Skip to content

DiFronzo/hackernews-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


HackerNews-API

Hacker News API for serving your front-end. Written in TypeScript and compatible with Deno Deploy.

HN-API version deno version license code size deployctl version

⚡️ Quick start

First of all, download and install Deno. Version 1.10 or higher is required.

Verify that the installation was successful by running the following command that should return the version number for Deno, v8 and TypeScript.

deno --version

Next install Deno Deploy (deployctl) 0.3.0 or later for running offline.

deno install --allow-read --allow-write --allow-env --allow-net --allow-run --no-check -f https://deno.land/x/deploy/deployctl.ts

Last step is to run the code in the repo.

deployctl run --libs=ns,fetchevent https://raw.githubusercontent.com/DiFronzo/hackernews-api/main/mod.tsx

The API should now be running on http://localhost:8080.

That's all you need to know to start! 🎉

Running online on Deno Deploy:
Deploy this example

⚙️ Usage & Options

See https://hackernews-api.deno.dev/doc/.

⭐️ Project assistance

If you want to say thank you or/and support active development of HackerNews-API:

⚠️ License

HackerNews-API is free and open-source software licensed under the MIT. This is not an offical release from HackerNews. Use on your own risk. Logo is owned by Weiran Zhang. It does not meet the threshold of originality needed for copyright protection, and is therefore in the public domain.