https://github.com/rishabh-pandey-sternx/newsapp

News App using GNEWS API
https://github.com/rishabh-pandey-sternx/newsapp

demo expressjs nestjs typescript

Last synced: 2 days ago
JSON representation

News App using GNEWS API

• Host: GitHub
• URL: https://github.com/rishabh-pandey-sternx/newsapp
• Owner: rishabh-pandey-sternx
• Created: 2023-05-15T12:56:06.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-05-17T12:33:12.000Z (over 1 year ago)
• Last Synced: 2024-09-26T17:23:37.529Z (about 2 months ago)
• Topics: demo, expressjs, nestjs, typescript
• Language: TypeScript
• Homepage:
• Size: 266 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Problem Statement

API should have a few basic methods like 

• fetching N news articles

• finding a news article with a specific title or author  

• searching by keywords

Include a cache in your API service as well so users are not fetching the same things over and over.

## Description

[NewsApp](https://github.com/geekrishabh/newsapp). News App repo

This is build using NESTJS. 

## Clone 

```bash

$ git clone https://github.com/GeekRishabh/newsapp.git

```

## Installation

```bash

$ npm install

```

## Running the app

Make sure you copy `.env.exmaple` and create `.env` 

update the value for .env that you can get from https://gnews.io/

```bash

# development

$ npm run start

# watch mode

$ npm run start:dev

# production mode

$ npm run start:prod

```

## Test

```bash

# unit tests

$ npm run test

# e2e tests

$ npm run test:e2e

# test coverage

$ npm run test:cov

```

## Swagger Document 

It can be accessed at host:port/api

Dev mode `http:localhost:3000/api`

## Deploying on Docker

docker build -t news-app .

docker run -dp 3000:3000 --name news-app news-app