hpuma / equest-explorer-backend

Fall 2023 - Web App with Financial News Integrations

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Description

Equest Explorer backend provides news articles related to stocks via News REST API integrations such as

Work in progress 🔧

  • Search in progress...

    Equest Frontend

Prerequisites

.env file in root directory

  • API keys procured from their respective websites
  • MongoDB URI for news record keeping
NODE_ENV="local"
INTEGRATIONS_ENABLED=true
BING_API_KEY=
NEWS_API_KEY=
ALPHAV_API_KEY=
MARKETAUX_API_KEY=
BING_API_KEY=
NEWSDATA_API_KEY=
GNEWS_API_KEY=
THENEWS_API_KEY=
MONGODB_URI=

Documentation

Endpoints

Endpoints

Swagger (OpenAPI)

  • run locally and proceed to http://localhost:3001/api

Swagger Documentation

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Technologies

TypeScript NPM NestJS MongoDB CircleCI RxJS ESLint Jest

About

Fall 2023 - Web App with Financial News Integrations


Languages

Language:TypeScript 91.8%Language:HTML 5.2%Language:CSS 2.5%Language:JavaScript 0.5%