https://github.com/tberey/social-stocks

A Graphical Data and Analysis Tool
https://github.com/tberey/social-stocks

data data-analysis data-science data-stream data-visualization database javascript mysql mysql-database node nodejs rest rest-api social-stocks stock-market stocks ticker-data tickers trends typescript

Last synced: 10 days ago
JSON representation

A Graphical Data and Analysis Tool

Host: GitHub
URL: https://github.com/tberey/social-stocks
Owner: tberey
Created: 2021-07-08T12:26:56.000Z (over 4 years ago)
Default Branch: development
Last Pushed: 2023-03-06T05:40:39.000Z (almost 3 years ago)
Last Synced: 2024-01-26T09:16:28.667Z (about 2 years ago)
Topics: data, data-analysis, data-science, data-stream, data-visualization, database, javascript, mysql, mysql-database, node, nodejs, rest, rest-api, social-stocks, stock-market, stocks, ticker-data, tickers, trends, typescript
Language: TypeScript
Homepage: https://github.com/tberey/social-stocks/blob/development/README.md
Size: 2.13 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 8
Metadata Files:
- Readme: README.md
- Security: SECURITY.md

Awesome Lists containing this project

README

          

[![Workflow][workflow-shield]][workflow-url]

[![Issues][issues-shield]][issues-url]

[![Version][version-shield]][version-url]

[![Stargazers][stars-shield]][stars-url]

[![Forks][forks-shield]][forks-url]

[![Contributors][contributors-shield]][contributors-url]

[![LinkedIn][linkedin-shield]][linkedin-url]






  

    

  



  

Social Stocks
A Graphical Data & Analysis Tool,
by TomCo (Technology & Online Media Company).

  

    


    Documentation »

    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  



  Contents

    


        

        About

        

            Tech Stack

        

        

        

        Startup

        

            Prerequisites

            Installation

        

        

        

        Usage

        

            Screenshots

        

        

        Roadmap

        Changelog

        Contributing

        Contact

        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

* [Typescript](https://www.typescriptlang.org/)

* [NodeJS](https://nodejs.org/en/)

* [Electron](https://www.electronjs.org/)

* [ExpressJS](https://expressjs.com/)

* [Chartjs](https://www.chartjs.org/)

* [MySQL](https://www.mysql.com/)

* [AWS](https://aws.amazon.com/)

* [EJS](https://ejs.co/)

* [Rollbar](https://rollbar.com/)

* [SimpleTxtLogger](https://www.npmjs.com/package/simple-txt-logger)

* [ESLint](https://eslint.org/)

* [MochaChai](https://mochajs.org/)





## 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!](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

1. Setup npm:

  ```sh

  npm install npm@latest -g

  ```




#### Installation

1. Clone/Download:

  ```sh

  git clone https://github.com/tberey/social-stocks.git

  ```

2. Install:

  ```sh

  npm install && npm update

  ```

3. Start:

  ```sh

  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. | "http://localhost:3000/" | GET |

| "/findBucket"
 | Attempt to find the passed bucket name. | "http://localhost:3000/findBucket?bucket=BUCKET_NAME" | GET |

| "/listObjects"
 | Lists all objects contained within a passed bucket, if the bucket exists. | "http://localhost:3000/listObjects?bucket=BUCKET_NAME" | GET |

| "/findObject"
 | Attempt to find passed object, in the passed bucket, if the bucket exists. | "http://localhost:3000/findObject?bucket=BUCKET_NAME&object=OBJECT_NAME" | GET |

| "/createBucket"
 | Create a new empty bucket, if one with the same name does not already exist. | "http://localhost:3000/createBucket" | POST |

| "/uploadFile"
 | Upload a local file to a specified bucket, if that bucket exists. | "http://localhost:3000/uploadFile" | POST |

| "/downloadFile"
 | Download a remote file from a specified bucket, if that bucket exists, and the file can be found. | "http://localhost:3000/downloadFile" | POST |

| "/tweetStreamRules"
 | Add, remove or list the rules that are currently applied to tweet stream filter. | "http://localhost:3000/tweetStreamRules" | POST |

| "/tweetStream"
 | Start or stop tweet stream manually, or automatically run for set number of tweet data sets. | "http://localhost:3000/tweetStream"
 | POST |




### Screenshots

Client Bar Chart (Daily) Rendered#1


![Screenshot#1](https://github.com/tberey/social-stocks/blob/development/screenshots/data-graph-screen1.png?raw=true)



Client Bar Chart (Daily) Rendered#2


![Screenshot#2](https://github.com/tberey/social-stocks/blob/development/screenshots/data-graph-screen2.png?raw=true)



Client Line Chart (Weekly) Rendered


![Screenshot#3](https://github.com/tberey/social-stocks/blob/development/screenshots/data-graph-screen3.png?raw=true)



Database Sample


![Screenshot#4](https://github.com/tberey/social-stocks/blob/development/screenshots/data-store-sample.png?raw=true)



Logging Sample


![Screenshot#5](https://github.com/tberey/social-stocks/blob/development/screenshots/local-logs-sample.png?raw=true)





## Roadmap

Below is the refined and confirmed roadmap, that has been planned for completion. See [open issues][issues-url] and also the [project board][project-url], 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;
tomberey1@gmail.com;

* [Issues & Requests][issues-url]

* [My Other Projects](https://github.com/tberey?tab=repositories)

* [Personal Website](https://tberey.github.io/)

* [Linked In](https://uk.linkedin.com/in/thomas-berey)




### Acknowledgements

* [Me](https://github.com/tberey)



TomCo™ (Technology & Online Media Company ©)


[workflow-shield]: https://github.com/tberey/social-stocks/actions/workflows/codeql-analysis.yml/badge.svg

[workflow-url]: https://github.com/tberey/social-stocks/actions

[version-shield]: https://img.shields.io/github/v/release/tberey/social-stocks

[version-url]: https://github.com/tberey/social-stocks/releases/

[stars-shield]: https://img.shields.io/github/stars/tberey/social-stocks.svg

[stars-url]: https://github.com/tberey/social-stocks/stargazers

[contributors-shield]: https://img.shields.io/github/contributors/tberey/social-stocks.svg

[contributors-url]: https://github.com/tberey/social-stocks/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/tberey/social-stocks.svg

[forks-url]: https://github.com/tberey/social-stocks/network/members

[issues-shield]: https://img.shields.io/github/issues/tberey/social-stocks.svg

[issues-url]: https://github.com/tberey/social-stocks/issues

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?logo=linkedin&colorB=555

[linkedin-url]: https://uk.linkedin.com/in/thomas-berey

[project-url]: https://github.com/tberey/social-stocks/projects

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/tberey/social-stocks

Awesome Lists containing this project

README

Social Stocks