HackerNews API Assignment

This repository contains the source of my solution to the hacker news API assignment.

The project uses yarn as the default package manager. However, you can use npm if you want.

The project is built using the following technologies: NestJs + Typescript + Jest

All responses are in JSON format and cached for 1 hour.

Installation Procedure

Clone this repository and cd into the directory

git clone git@github.com:iamolayemi/hacker-news-api-assignment.git

cd hacker-news-api-assignment

yarn install 

# using npm
npm install

yarn start:dev

# using npm
npm run start:dev

This will start a new server on port 3000
To get the top 10 words in the title of the last 25 stories, visit http://localhost:3000/top-words/new-stories
To get the top 10 words in the title of top user stories, visit http://localhost:3000/top-words/top-stories
To get the top 10 words in the title of a post of exactly last week, visit http://localhost:3000/top-words/last-week-stories

# unit tests
yarn test

# test coverage
yarn test:cov

# using npm
npm run test
npm run test:cov