/hacker-news-proxy-api

Implementation of a service that acts as a layer between the source hacker-news and a third-party which provides list of stories.

Primary LanguageTypeScript

A proxy API for hacker-news API

A service that acts as a proxy between the services hacker-news and a third-party. This proxy service offers an API to retrieve and manage list of stories from the hacker news storage.

Technologies and tools

  • Node
  • Express
  • MongoDB
  • OpenAPI 3

Usage

1. Clone the repository.

git clone https://github.com/gtopsis/hacker-news-proxy-api.git

2. Create .env file with the following:

HACKER_NEWS_HOST=https://hacker-news.firebaseio.com
HACKER_NEWS_API_VERSION=v0

MONGODB_USER=root
MONGODB_PASSWORD=123456
MONGODB_DATABASE=hacker_news_proxy_api_db
MONGODB_LOCAL_PORT=7017
MONGODB_DOCKER_PORT=27017
MONGODB_NAME=hackerNewsDB
MONGODB_HOST=mongodb

NODE_LOCAL_PORT=6868
NODE_DOCKER_PORT=8080

3. Build the app and use Docker:

npm run build

4. Start and attach to containers the service.

docker compose up --build

Available services (see also API document)