Skip to content

tberey/social-stocks

Repository files navigation

Workflow Issues Version Stargazers Forks Contributors LinkedIn


TomCo (Technology & Online Media Company) Logo

Social Stocks

A Graphical Data & Analysis Tool,
by TomCo (Technology & Online Media Company).
Contents
  1. About
  2. Startup
  3. Usage
  4. Roadmap
  5. Changelog
  6. Contributing
  7. Contact
  8. Acknowledgements


About This Project

Social Stocks is a graphing data and analysis tool, by TomCo (Technology & Online Media Company). This web, or desktop, application collects data from social media sources (such as the Twitter or Reddit APIs), as well as on google search trends, to extrapolate and illustrate potential stock movements or trends, into a user-friendly graphical format.

This application, or any data, trends and patterns, that can be discerned, should not be taken as financial advice, or as a definitive indication of the movement of the underlying security/asset. The purpose of this app is to merely help in identifying trends or any high social traffic, on a particular ticker or security; and potentially add further insight in your own decision making. Be smart, take responsibility, and never risk money you need.

Tech Stack




Startup

For help or guidance in downloading and running the application, see the following subsections.

Prerequisites

You must have npm (node package manager) and Nodejs installed on your system!

  1. Setup npm:
npm install npm@latest -g

Installation

  1. Clone/Download:
git clone https://github.com/tberey/social-stocks.git
  1. Install:
npm install && npm update
  1. Start:
npm run start:app




Usage

Endpoint Action/Desc. Full URI (hosted locally, for some port; e.g.: 3000) Request Type
  • "/"
Index:
Returns empty 200 status response.
GET
  • "/findBucket"
Attempt to find the passed bucket name. GET
  • "/listObjects"
Lists all objects contained within a passed bucket, if the bucket exists. GET
  • "/findObject"
Attempt to find passed object, in the passed bucket, if the bucket exists. GET
  • "/createBucket"
Create a new empty bucket, if one with the same name does not already exist. POST
  • "/uploadFile"
Upload a local file to a specified bucket, if that bucket exists. POST
  • "/downloadFile"
Download a remote file from a specified bucket, if that bucket exists, and the file can be found. POST
  • "/tweetStreamRules"
Add, remove or list the rules that are currently applied to tweet stream filter. POST
  • "/tweetStream"
Start or stop tweet stream manually, or automatically run for set number of tweet data sets. POST

Screenshots

Client Bar Chart (Daily) Rendered#1
Screenshot#1

Client Bar Chart (Daily) Rendered#2
Screenshot#2

Client Line Chart (Weekly) Rendered
Screenshot#3

Database Sample
Screenshot#4

Logging Sample
Screenshot#5




Roadmap

Below is the refined and confirmed roadmap, that has been planned for completion. See open issues and also the project board, for any other proposed features or known issues, which may not be listed below.

Feature/Task/Bugfix Details Version (if released) Notes
Bug#1 Bug details... 0.0.1 example#1
Feature#4 Feature details... example#2
Google Search Terms Analytics Graph(s) Collect data on search terms (that are gathered from social media?) and graph it. Not started.
Extra/New Data Representation Graph(s) Add extra graph types, like pie etc. Not started. Low Priority.
Catch Weekly Graph Reload Add a catch if the weekly graph needs a reload, to reload automatically Not Started.




Changelog

Version Date Changes
0.1.1 2021-07-08
  • Initial Commit.
  • Add initial directory structure and files.
  • Add Screenshots directory, and images.
  • Create and format README.md
0.1.2 2021-07-14
  • Remove local SimpleTxtLogger, replaced with npm module SimpleTxtLogger.
  • AWS Types Updates.
  • CodeQL workflow branch update.
  • Update README.md
0.1.3 2021-08-03
  • Fix Spelling.
  • Update README.md
0.1.4 2021-08-04
  • Update README.md




Contributing

Contributions are welcomed and, of course, greatly appreciated.

  1. Fork the Project.
  2. Create your Feature Branch (git checkout -b feature/Feature)
  3. Commit your Changes (git commit -m 'Add some Feature')
  4. Push to the Branch (git push origin feature/Feature)
  5. Open a Pull Request.




Contact

Tom Berey; Project Manager, Lead Developer, Principal Tester & Customer Services;
[email protected];


Acknowledgements




TomCo™ (Technology & Online Media Company ©)