Merge pull request #5 from tberey/development

Release/0.1.4

.eslintignore

@@ -1,4 +1,7 @@
 node_modules
 build
 logs
-private
+private
+downloads
+exports
+.env

.github/workflows/codeql-analysis.yml

@@ -2,7 +2,7 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ development ]
+    branches: [ development, main ]
   pull_request:
     # The branches below must be a subset of the branches above
     branches: [ main ]

.gitignore

@@ -3,4 +3,5 @@ build
 logs
 private
 downloads
+exports
 .env

README.md

@@ -86,6 +86,7 @@ Social Stocks is a graphing data and analysis tool, by TomCo (Technology & Onlin
 * [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/)
 
@@ -95,10 +96,12 @@ Social Stocks is a graphing data and analysis tool, by TomCo (Technology & Onlin
 
 <!-- STARTUP -->
 ## Startup
-For help or guidance in downloading and running the application, see the following subsections. In a future update, there will be more extensive and complete instructions, as well as db migration and ifra setup scripts.
+For help or guidance in downloading and running the application, see the following subsections.
 <br>
 
 #### 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
@@ -126,9 +129,18 @@ For help or guidance in downloading and running the application, see the followi
 <!-- USAGE EXAMPLES -->
 ## Usage
 
-| Endpoint | Action/Desc. | Full URI <i>(hosted locally, for some port; e.g.: 3000)</i> |
-|:---|:---|:---|
-| <ul><li>"/"</li></ul> | Homepage:<br>The client-side landing page. | <ul><li>"http://localhost:3000/"</li></ul> |
+| Endpoint | Action/Desc. | Full URI <i>(hosted locally, for some port; e.g.: 3000)</i> | Request Type |
+|:---|:---|:---|:---|
+| <ul><li>"/"</li></ul> | Index:<br>Returns empty 200 status response. | <ul><li>"http://localhost:3000/"</li></ul> | GET |
+| <ul><li>"/findBucket"</li></ul> | Attempt to find the passed bucket name. | <ul><li>"http://localhost:3000/findBucket?bucket=BUCKET_NAME"</li></ul> | GET |
+| <ul><li>"/listObjects"</li></ul> | Lists all objects contained within a passed bucket, if the bucket exists. | <ul><li>"http://localhost:3000/listObjects?bucket=BUCKET_NAME"</li></ul> | GET |
+| <ul><li>"/findObject"</li></ul> | Attempt to find passed object, in the passed bucket, if the bucket exists. | <ul><li>"http://localhost:3000/findObject?bucket=BUCKET_NAME&object=OBJECT_NAME"</li></ul> | GET |
+| <ul><li>"/createBucket"</li></ul> | Create a new empty bucket, if one with the same name does not already exist. | <ul><li>"http://localhost:3000/createBucket"</li></ul> | POST |
+| <ul><li>"/uploadFile"</li></ul> | Upload a local file to a specified bucket, if that bucket exists. | <ul><li>"http://localhost:3000/uploadFile"</li></ul> | POST |
+| <ul><li>"/downloadFile"</li></ul> | Download a remote file from a specified bucket, if that bucket exists, and the file can be found. | <ul><li>"http://localhost:3000/downloadFile"</li></ul> | POST |
+| <ul><li>"/tweetStreamRules"</li></ul> | Add, remove or list the rules that are currently applied to tweet stream filter. | <ul><li>"http://localhost:3000/tweetStreamRules"</li></ul> | POST |
+| <ul><li>"/tweetStream"</li></ul> | Start or stop tweet stream manually, or automatically run for set number of tweet data sets. | <ul><li>"http://localhost:3000/tweetStream"</li></ul> | POST |
+
 
 <br>
 
@@ -157,7 +169,8 @@ Below is the refined and confirmed roadmap, that has been planned for completion
 | <i>Bug#1</i> | <i>Bug details...</i> | <i>0.0.1</i> | <i>example#1</i> |
 | <i>Feature#4</i> | <i>Feature details...</i> |   | <i>example#2</i> |
 | 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 graphy types, like pie etc. |   | Not started. Low Priority. |
+| 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. |
 
 <br><hr><br>
 
@@ -168,7 +181,10 @@ Below is the refined and confirmed roadmap, that has been planned for completion
 
 | Version | Date | Changes |
 |:---|:---|:---|
-| 0.1.1 | 2021-07-08 | <ul><li>Initial Commit.</li><li>Add inital directory structure and files.</li><li>Add Screenshots directory, and images.</li><li>Create and format README.md</li></ul> |
+| 0.1.1 | 2021-07-08 | <ul><li>Initial Commit.</li><li>Add initial directory structure and files.</li><li>Add Screenshots directory, and images.</li><li>Create and format README.md</li></ul> |
+| 0.1.2 | 2021-07-14 | <ul><li>Remove local SimpleTxtLogger, replaced with npm module SimpleTxtLogger.</li><li>AWS Types Updates.</li><li>CodeQL workflow branch update.</li><li>Update README.md</li></ul> |
+| 0.1.3 | 2021-08-03 | <ul><li>Fix Spelling.</li><li>Update README.md</li></ul> |
+| 0.1.4 | 2021-08-04 | <ul><li>Update README.md</li></ul> |
 
 <br><hr><br>
 
@@ -191,12 +207,12 @@ Contributions are welcomed and, of course, **greatly appreciated**.
 <!-- CONTACT -->
 ### Contact
 
-<b>Tom Berey</b>; <i>Project Manager, Lead Developer, Principal Tester & Customer Services</i> - [email protected]
+<b>Tom Berey</b>; <i>Project Manager, Lead Developer, Principal Tester & Customer Services</i>;<br>[email protected];
 
 * [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-2a1860129)
+* [Linked In](https://uk.linkedin.com/in/thomas-berey)
 
 <br>
 
@@ -226,5 +242,5 @@ Contributions are welcomed and, of course, **greatly appreciated**.
 [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-2a1860129
+[linkedin-url]: https://uk.linkedin.com/in/thomas-berey
 [project-url]: https://github.com/tberey/social-stocks/projects