7 |
3 |
7 |
10 | 
51 |
52 | ## Send Data
53 | - Insert data into message input
54 | - Emit data!
55 |
56 | 
60 |
61 |
62 | ## Create and send Data Streams to Connected Clients
63 | - Connect a client application by opening a websocket connection to the specified port.
64 | - Open stream planner and construct stream with messages and delays.
65 | - Send the stream!
66 |
67 | 
71 |
72 | ## Development
73 | ### Built With
74 | * Electron
75 | * TypeScript
76 | * React
77 | * Redux
78 | * Redux-thunk
79 | * Websockets
80 | * Jest
81 | * Webpack
82 |
83 |
84 | ### Client
85 | Socketcast is an Electron cross platform desktop app. It is built with React.
86 |
87 | ### ServerManager
88 | Socketcast has the ability to launch multiple WebSocket servers and it does so through an abstraction called ServerManager. The client application should never manage any servers directly, but instead interact with ServerManager's exposed API through Redux actions.
89 |
90 | ## What's next?
91 | * Add support for other protocols such as HTTP2
92 | * Create the ability to build URL paths for the client application to subscribe selectively to events
93 | * Add ability to parse authentication headers
94 | * Log debugging information from client
95 |
96 | ## Want to contribute?
97 | Socketcast encourages contributions to this product, pull requests are welcome.
98 |
99 | Fork the repo and create a working branch from master.
100 | If you've added any code that requires testing, add tests.
101 | Check to ensure that all tests pass.
102 | Make sure code is formatted with prettier and follows the Airbnb React/JSX Style Guide.
103 | Create a pull request to master.
104 |
105 | Issues
106 | Please do not hesitate to file issues. Socketcast is based off of community feedback and is always looking for ways to get better. We are interested to hear about your experience and how we can improve Socketcast.
107 |
108 |
109 | ## Authors
110 | * Will Bladon [whbladon](https://github.com/whbladon)
111 | * Chris Docuyanan [cjo2](https://github.com/cjo2)
112 | * Chance Hernandez [ItsChance-BTW](https://github.com/ItsChance-BTW)
113 | * Colin Vandergraaf [colinvandergraaf](https://github.com/colinvandergraaf)
114 |
115 | ## License
116 | [License](https://github.com/oslabs-beta/socketcast/LICENSE)
117 |
--------------------------------------------------------------------------------
/assets/CreateStopStartDelete.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oslabs-beta/socketcast/f0f1c7d9f7f414ace50f1dd8045ab91b4d68f858/assets/CreateStopStartDelete.gif
--------------------------------------------------------------------------------
/assets/EmitMessages.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oslabs-beta/socketcast/f0f1c7d9f7f414ace50f1dd8045ab91b4d68f858/assets/EmitMessages.gif
--------------------------------------------------------------------------------
/assets/PlannedResponse.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oslabs-beta/socketcast/f0f1c7d9f7f414ace50f1dd8045ab91b4d68f858/assets/PlannedResponse.gif
--------------------------------------------------------------------------------
/assets/socketcast_logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oslabs-beta/socketcast/f0f1c7d9f7f414ace50f1dd8045ab91b4d68f858/assets/socketcast_logo.png
--------------------------------------------------------------------------------
/babel.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | presets: [
3 | ["@babel/preset-env", { targets: { node: "current" } }],
4 | "@babel/preset-typescript",
5 | ],
6 | };
7 |
--------------------------------------------------------------------------------
/jest.config.js:
--------------------------------------------------------------------------------
1 | /*
2 | * For a detailed explanation regarding each configuration property, visit:
3 | * https://jestjs.io/docs/en/configuration.html
4 | */
5 |
6 | module.exports = {
7 | // All imported modules in your tests should be mocked automatically
8 | // automock: false,
9 |
10 | // Stop running tests after `n` failures
11 | // bail: 0,
12 |
13 | // The directory where Jest should store its cached dependency information
14 | // cacheDirectory: "/private/var/folders/y4/y327ndqj61jgklgthkpm9tyr0000gn/T/jest_dx",
15 |
16 | // Automatically clear mock calls and instances between every test
17 | // clearMocks: false,
18 |
19 | // Indicates whether the coverage information should be collected while executing the test
20 | collectCoverage: true,
21 |
22 | // An array of glob patterns indicating a set of files for which coverage information should be collected
23 | // collectCoverageFrom: undefined,
24 |
25 | // The directory where Jest should output its coverage files
26 | coverageDirectory: "coverage",
27 |
28 | // An array of regexp pattern strings used to skip coverage collection
29 | // coveragePathIgnorePatterns: [
30 | // "/node_modules/"
31 | // ],
32 |
33 | // Indicates which provider should be used to instrument code for coverage
34 | coverageProvider: "v8",
35 |
36 | // A list of reporter names that Jest uses when writing coverage reports
37 | // coverageReporters: [
38 | // "json",
39 | // "text",
40 | // "lcov",
41 | // "clover"
42 | // ],
43 |
44 | // An object that configures minimum threshold enforcement for coverage results
45 | // coverageThreshold: undefined,
46 |
47 | // A path to a custom dependency extractor
48 | // dependencyExtractor: undefined,
49 |
50 | // Make calling deprecated APIs throw helpful error messages
51 | // errorOnDeprecated: false,
52 |
53 | // Force coverage collection from ignored files using an array of glob patterns
54 | // forceCoverageMatch: [],
55 |
56 | // A path to a module which exports an async function that is triggered once before all test suites
57 | // globalSetup: undefined,
58 |
59 | // A path to a module which exports an async function that is triggered once after all test suites
60 | // globalTeardown: undefined,
61 |
62 | // A set of global variables that need to be available in all test environments
63 | // globals: {},
64 |
65 | // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
66 | // maxWorkers: "50%",
67 |
68 | // An array of directory names to be searched recursively up from the requiring module's location
69 | // moduleDirectories: [
70 | // "node_modules"
71 | // ],
72 |
73 | // An array of file extensions your modules use
74 | // moduleFileExtensions: [
75 | // "js",
76 | // "json",
77 | // "jsx",
78 | // "ts",
79 | // "tsx",
80 | // "node"
81 | // ],
82 |
83 | // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
84 | // moduleNameMapper: {},
85 |
86 | // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
87 | // modulePathIgnorePatterns: [],
88 |
89 | // Activates notifications for test results
90 | // notify: false,
91 |
92 | // An enum that specifies notification mode. Requires { notify: true }
93 | // notifyMode: "failure-change",
94 |
95 | // A preset that is used as a base for Jest's configuration
96 | // preset: undefined,
97 |
98 | // Run tests from one or more projects
99 | // projects: undefined,
100 |
101 | // Use this configuration option to add custom reporters to Jest
102 | // reporters: undefined,
103 |
104 | // Automatically reset mock state between every test
105 | // resetMocks: false,
106 |
107 | // Reset the module registry before running each individual test
108 | // resetModules: false,
109 |
110 | // A path to a custom resolver
111 | // resolver: undefined,
112 |
113 | // Automatically restore mock state between every test
114 | // restoreMocks: false,
115 |
116 | // The root directory that Jest should scan for tests and modules within
117 | // rootDir: undefined,
118 |
119 | // A list of paths to directories that Jest should use to search for files in
120 | // roots: [
121 | // "
58 |