diff --git a/index.html b/index.html index 67428e1..b75d206 100644 --- a/index.html +++ b/index.html @@ -1,11 +1,72 @@ - - - -Our Funky HTML Page - - - - -Content goes here. - - +

Description

+

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

+ +

Work in progress 🔧

+ +

Prerequisites

+

.env file in root directory

+ +
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)

+ +

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