Bläddra i källkod

Update 'README.md'

woat 6 år sedan
förälder
incheckning
5019f0b336
1 ändrade filer med 53 tillägg och 38 borttagningar
  1. 53
    38
      README.md

+ 53
- 38
README.md Visa fil

@@ -1,51 +1,66 @@
1 1
 # Stockr
2 2
 
3
-Stockr (pronounced `/ˈstôkər/`, like stalker), is a data-driven platform utilizing regression techniques to model predictive indicators on stock valuation.
3
+Stockr (pronounced `/ˈstôkər/`, like stalker), is a data-driven platform utilizing natural language processig regression techniques to model predictive and historical indicators on stock valuation in real time. 
4 4
 
5 5
 ![c](https://images.unsplash.com/photo-1460925895917-afdab827c52f?ixlib=rb-0.3.5&s=d8791fe0f9f4e735158400f9daf6a558&auto=format&fit=crop&w=1602&q=80)
6 6
 
7 7
 ### Data aggregation
8 8
 
9
-At Stockr, our primary analytics consist of leveraging public consumer media and deriving a baseline score from syntactic structures to process semantic analysis. 
9
+At Stockr, our primary analytics consist of leveraging public consumer media and deriving a baseline score from syntactic structures to process semantic analysis. Our main focus is to provide value and help create strategic decisions to potential investors based on our data aggregation and analytics.
10
+
11
+### Application Communication Diagram
10 12
 
11 13
 ```
12
-                                         +-----------------+
13
-                                         |                 |
14
-                                         | User Schema     |          +----------------+
15
-                                         |                 +---------->                |
16
-                                         | Semantic Schema |          | MySQL Database |
17
-                                         |                 <----------+                |
18
-                                         | Scoring Schema  |          +-----+---^------+
19
-                                         |                 |                |   |
20
-                                         +-----------------+                |   |
21
-                                                                            |   |
22
-                                                                            |   |
23
-                                                                            |   |
24
-                                                                            |   |
25
-                                  +-----------------------------------------v---+-------------+
26
-                                  |                                                           |
27
-                                  |                         Server                            |
28
-                                  |                                                           |
29
-                                  | Data Capturing    Processing Pipeline   Data Processing   |
30
-                                  |                                                           |
31
-                                  | Web Crawler       Queue Monitor         Semantic Analysis |
32
-                                  |                                                           |
33
-                                  |                   Data Store                              |
34
-                                  |                                                           |
35
-                                  +------------------------+--------^-------------------------+
36
-                                                           |        |
37
-                                                           |        |
38
-                                                           |        |
39
-                                                           |        |
40
-                                                     +-----v--------+-----+
41
-                                                     |                    |
42
-                                                     | Application View   |
43
-                                                     |                    |
44
-                                                     | Data Visualization |
45
-                                                     |                    |
46
-                                                     +--------------------+
14
+                                                            +-----------------------------------------------------------+
15
+        +-----------------+                                 |                                                           |
16
+        |                 |                                 |                         Server                            |
17
+        | User Schema     |          +----------------+     |                                                           |
18
+        |                 +---------->                +-----> Data Capturing    Processing Pipeline   Data Processing   |
19
+        | Semantic Schema |          | MySQL Database |     |                                                           |
20
+        |                 <----------+                <-----+ Web Crawler       Queue Monitor         Semantic Analysis |
21
+        | Scoring Schema  |          +----------------+     |                                                           |
22
+        |                 |                                 |                   Data Store                              |
23
+        +-----------------+                                 |                                                           |
24
+                                                            +------------------------+--------^-------------------------+
25
+                                                                                     |        |
26
+                                                                                     |        |
27
+                                                                                     |        |
28
+                                                                                     |        |
29
+                                                                               +-----v--------+-----+
30
+                                                                               |                    |
31
+                                                                               | Application View   |
32
+                                                                               |                    |
33
+                                                                               | Data Visualization |
34
+                                                                               |                    |
35
+                                                                               +--------------------+
36
+
47 37
 ```
48 38
 
39
+### Technology Stack
40
+
41
+Stockr implements bleeding-edge technology to serve and deliver content as nimble as possible. By leveraging modern tools available in the Java ecosystem, we have created an infrastructure that is fast, efficent, light, and secure. We have chosen a streamlined approach to scaling our architecture horizontally by effectuating the resources available with cloud computing.
42
+
43
+Our client-side architecture consists of:
44
+- Vue.js
45
+- SCSS
46
+- HTML5
47
+- Webpack
48
+- Babel
49
+- ES6(+)
50
+
51
+Our server-side architecture consists of:
52
+- Java
53
+- Spring Boot
54
+- Golang
55
+- Tomcat with embedded H2
56
+- Amazon Linux EC2
57
+
58
+
59
+### 3rd Party API Services
60
+
61
+(News API)[https://newsapi.org/] - Live reports of consumer media and real time updates on current trending topics.
62
+(Parallel Dots API)[https://www.paralleldots.com/] - Artificial intelligence analysis and processing computations.
63
+
49 64
 ##### SEC Compliance
50 65
 
51
-These securities have not been approved or disapproved by the SEC nor have any representations been made about the accuracy of the adequacy of the information.
66
+These securities have not been approved or disapproved by the SEC nor have any representations been made about the accuracy of the adequacy of the information. Stockr makes no representations or warranties regarding the advisability of investing in any product or service offered by any 3rd party integration service. Stockr has no obligation or liability in connection with the operation, marketing, trading or sale of any product or service offered by any 3rd party integration service.