-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
128 lines (120 loc) · 6.24 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Henry Puma - Equest Explorer</title>
<meta name="author" content="hpuma">
<meta name="description" content="equest explorer project page">
<meta name="keywords" content="newsapi, alphavantage, marketaux, bing, newsdata, gnews, thenewsapi">
<meta name="robots" content="noodp,noydir">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="assets/css/index.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Montserrat|Inconsolata:400,700|Source+Code+Pro">
<meta property="og:title" content="Henry Puma's website">
<meta property="og:description" content="A website portfolio for Henry">
<meta property="og:type" content="portfolio">
<meta property="og:image" content="https://github.com/hpuma/equest-explorer-web/blob/main/equest.gif" />
</head>
<body>
<div class="container">
<h1>Equest Explorer</h1>
<a class="badges" href="https://app.circleci.com/pipelines/github/hpuma/equest-explorer-backend/"><img
alt="CircleCI" src="https://img.shields.io/circleci/build/github/hpuma/equest-explorer-backend/main"></a>
<a class="badges" href="https://github.com/hpuma/equest-explorer-backend/commits/main/"><img
alt="GitHub commit activity"
src="https://img.shields.io/github/commit-activity/m/hpuma/equest-explorer-backend">
</a>
<a class="badges" href="https://github.com/hpuma/equest-explorer-backend/commits/main/">
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/hpuma/equest-explorer-backend">
</a>
<br>
<a class="badges" href="https://github.com/hpuma/equest-explorer-backend"><img alt="GitHub Repo stars"
src="https://img.shields.io/github/stars/hpuma/equest-explorer-backend">
</a>
<br>
<blockquote>Equest explorer is a web application built using React, Axios, Vite, and Ant Design (antd) that provides
users with a comprehensive
toolset for tracking stocks, accessing news related to financial markets, and analyzing stock data.</blockquote>
<div><img class="badges"
src="https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white"
alt="TypeScript">
<img src="https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white"
class="badges" alt="NPM">
<img
src="https://img.shields.io/badge/nestjs-%23E0234E.svg?style=for-the-badge&logo=nestjs&logoColor=white"
class="badges" alt="NestJS">
<img
src="https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white"
class="badges" alt="MongoDB">
<img
src="https://img.shields.io/badge/circle%20ci-%23161616.svg?style=for-the-badge&logo=circleci&logoColor=white"
class="badges" alt="CircleCI">
<img
src="https://img.shields.io/badge/rxjs-%23B7178C.svg?style=for-the-badge&logo=reactivex&logoColor=white"
class="badges" alt="RxJS">
<img src="https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white"
class="badges" alt="ESLint">
<img src="https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white"
class="badges" alt="Jest">
</div>
<br />
<br />
<p><img src="./assets/img/equest.gif" alt="equest screenshot"></p>
<h2>Features</h2>
<ul>
<li><strong>Stock Quote for Ticker:</strong> Users can input a stock ticker symbol to retrieve real-time stock
quotes.
</li>
<li><strong>Enable/Disable Stock Chart via Trading View:</strong> Users can toggle the display of a stock chart
powered by TradingView to visualize stock data.</li>
<li><strong>Theme Changes (Dark vs Light):</strong> Users can switch between dark and light themes for better
readability and user preference.</li>
<li><strong>News Sources Ingested from Multiple APIs:</strong> News articles related to stocks are sourced from
multiple APIs including News API, Alpha Vantage, Marketaux, Bing, NewsData, and TheNewsAPI.</li>
<li><strong>Ticker Search (On Key Type):</strong> As users type, the application dynamically searches for stock
tickers and provides suggestions for auto-completion.</li>
<li><strong>News Preview Viewer with Vertical Adjustment:</strong> Users can view a preview of news articles with
the
ability to vertically adjust the content for better readability.</li>
<li><strong>Responsive Table with Filtering and Sorting:</strong> A responsive table displays stock data with
features
for filtering and sorting based on various parameters such as author, date published, date found, and news
source (API source).</li>
</ul>
<h2>Integrations</h2>
<ul>
<li><a href="https://newsapi.org/docs">NewsAPI</a></li>
<li><a href="https://www.alphavantage.co/documentation/">AlphaVantage</a></li>
<li><a href="https://www.marketaux.com/documentation">Marketaux</a></li>
<li><a href="https://www.microsoft.com/en-us/bing/apis/bing-news-search-api">Bing</a> (2/7/2024)</li>
<li><a href="https://newsapi.org/">NewsData</a> (2/8/2024)</li>
<li><a href="https://gnews.io/docs/v4#introduction">GNews</a> (2/8/2024)</li>
<li><a href="https://www.thenewsapi.com/documentation">TheNewsAPI</a> (2/8/2024)</li>
</ul>
<h2>Prerequisites</h2>
<p><code>.env file</code> in root directory</p>
<p>API keys procured from their respective websites</p>
<p>MongoDB URI for news record keeping</p>
<pre><code>
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=
</code></pre>
<h2 id="installation">
<a href="#installation">§</a>
Installation
</h2>
<p>Navigate to root directory in terminal and type command:</p>
<pre>npm install</pre>
</div>
</body>
</html>