Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 3.42 KB

README.md

File metadata and controls

75 lines (54 loc) · 3.42 KB

Financial Sentiment Based on News

Tutorial

  • Use this application to gauge the latest relevant news articles about any company of your interest.
  • You may search by the listed company name (e.g.Alphabet Inc.), common name (e.g. Google), ticker (e.g. GOOGL), or even have a typo in the query (e.g. Gogle).
    • we use special APIs to map your request to the traded ticker and make sure to retrieve the latest and the most relevant stock and news data.
    • the way you spell the company will not affect your search results.
  • You can also send requests directly to our API (refer to the backend) and parse the JSON file with the news, stock data, and sentiment yourself.
  • We get data from 1800+ reputable news sources and organize them with regard to importance and relevancy so that you don't have to!

Components

API

There is a separate server that acts as an API. The server is built with Flask. For more efficient responses multi-threading and cache are used. Refer to the Backend README

UI

User interface is built with React and Tailwind with an elegant and minimalist design delivering a clear and pleasant experience to the user. Refer to the Frontend README

Usage

  1. Follow the instructions for staring the API
  2. Follow the instructions for staring the FrontEnd
  3. You may access the server at localhost:3000.

Project Organization

├── README.md          <- The top-level README for developers using this project.
|
├── docs               <- Assignment Deliverables          
│
├── test               <- Tests for Project           
│
└── project <- Project Code for Front and Backend
    |
    ├──finsenti_backend
    |   |
    |   └──src                 <- Code for Flask Backend
    |     |
    |     ├── templates        <- HTML templates used for testing
    |     ├── main.py   <- Script for Backend
    |     └── requirements.txt <- Required Packages to Run Backend
    │
    └──finsenti_frontend     
          |
          ├── src            <- Code for React Frontend
          |   |
          |   ├── adapters   <- Functions with API Calls
          |   ├── components <- JSX Components that make up the site
          |   ├── hooks      <- Custom Hooks for the app
          |   ├── images     <- Images and Icons for the site
          |   └── App.tsx    <- Central component for App
          │
          ├── tailwind.config.js <- Config file for tailwind
          ├── tsconfig.json      <- Config files for typescript
          └── package.json       <- Node packages used to make app