Merge pull request #326 from oslabs-beta/master

PR for most recent iteration of Swell

Author: ywy-w

.eslintrc.js

@@ -34,8 +34,8 @@ module.exports = {
   // ===========================================
   // Set up ESLint for .js / .jsx files
   // ===========================================
-  // .js / .jsx uses babel-eslint
-  parser: 'babel-eslint',
+  // .js / .jsx uses @babel/eslint-parser
+  parser: '@babel/eslint-parser',
   parserOptions: {
     ecmaVersion: 2020,
     sourceType: 'module',

.gitignore

@@ -13,6 +13,11 @@ package-lock.json
 coverage/
 .vscode
 src/client/docs/
+test/failedTests
+.nyc_output
+jest-coverage
+mocha-coverage
+total-coverage
 
 # Folder config file #
 ######################
@@ -64,7 +69,9 @@ protos/
 
 # testing #
 test/subSuites/*.png
+test/failedTests/*
+.nyc_output
 
 
 # db #
-.env
+.env

.jshintrc

@@ -16,7 +16,7 @@ We use Github to host code, to track issues and feature requests, as well as acc
 Pull requests are the best way to propose changes to Swell. We actively welcome your pull requests:
 
 1. Fork the repo and create your branch from `dev`.
-2. If you've added code that should be tested, add tests.
+2. If you've added code that should be tested, add tests (see testing details above "License" below).
 3. If you've changed APIs, update the documentation.
 4. Ensure the test suite passes.
 5. Make sure your code lints.
@@ -49,6 +49,18 @@ People _love_ thorough bug reports. I'm not even kidding.
 - 2 spaces for indentation rather than tabs
 - You can try running `npm run lint` for style unification
 
+## Test early, test often!
+
+- Run npm run test or npm run test-mocha for E2E testing with [Playwright](https://playwright.dev/docs/api/class-electron) and Mocha
+- Run npm run test-jest for unit and integration tests with Jest 
+- Check code coverage!
+  - In the 'test/coverage' directory, check jest-coverage and mocha-coverage directories
+    - View each index.html in your browser for coverage reports generated with Istanbul that will show covered and uncovered lines in accessed modules
+  - Merge the coverage reports by running npm run report
+    - View an overall coverage report at index.html in the total-coverage directory
+- Contribute to the testing suite
+  - Add tests for uncovered lines, modules, functions. Leave no stone unturned!
+
 ## License
 
 By contributing, you agree that your contributions will be licensed under its MIT License.

.nvmrc

@@ -8,7 +8,7 @@
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/getswell/getswell/issues)
 [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Swell-%20For%20all%20your%20streaming%20API%20testing%20needs&url=https://www.getswell.io&hashtags=SSE,WebSocket,HTTP,API,developers)
 
-Swell is a API development tool that enables developers to test endpoints served over streaming technologies including Server-Sent Events (SSE), WebSockets, HTTP2, GraphQL and gRPC.
+Swell is an API development tool that enables developers to test endpoints served over streaming technologies including Server-Sent Events (SSE), WebSockets, HTTP2, GraphQL, gRPC, WebRTC, and OpenAPI.
 
 ## Getting Started
 
@@ -71,19 +71,16 @@ Swell is a one-stop shop for sending and monitoring your API requests
     ]
     ```
 
-- _Webhooks_: Swell includes user-defined HTTP callback connection testing designed to test other server's connection to the web and ability to send data. The test insures that when an event occurs, the source site makes an HTTP request to the URL configured for the webhook. 
-  <kbd><img src="./ReadMeGifs/Gifs/Webhook.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
 
 ## Additional Features
 
-- _Send Request Directly to Endpoint_: You are able to immedeately send a request to an endpoint OR stage a request in your workspace for multi-level testing.
+- _Send Request Directly to Endpoint_: You are able to immediately send a request to an endpoint OR stage a request in your workspace for multi-level testing.
   <kbd><img src="./ReadMeGifs/Gifs/DirectSendRequest.gif"
        style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
 - _Scripting in Swell_: Swell allows you to write assertion tests to aid in the test-driven development cycle of backend API services.
   <kbd><img src="./ReadMeGifs/Gifs/SimpleResponseTest.gif"
        style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
 - _Workspaces_: Swell allows you to save workspaces for easier testing of multiple requests.
-- _Import/Export Workspaces_: Swell allows you to import and export workspaces, making it easy to share collections with your team.
 - _Preview_: You can now view a rendered preview of certain API responses (HTML)
   <kbd><img src="./ReadMeGifs/Gifs/AdditionalFeatures.gif"
        style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
@@ -93,14 +90,24 @@ Swell is a one-stop shop for sending and monitoring your API requests
 - _Schedule Tests_: You can also automate sending requests to occur on a periodic basis.
   <kbd><img src="./ReadMeGifs/Gifs/ScheduleTest.gif"
        style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
-- _Dark Mode_: Swell allows you to toggle between light and dark mode when viewing the application.  
-  <kbd><img src="./ReadMeGifs/Gifs/DarkMode.gif"
-       style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
 
+## WIP Features
+**Clone this repo and check out dev mode for the latest and greatest!**
+
+- _Webhooks_: Swell includes user-defined HTTP callback connection testing designed to test other server's connection to the web and ability to send data. The test insures that when an event occurs, the source site makes an HTTP request to the URL configured for the webhook. 
+  <kbd><img src="./ReadMeGifs/Gifs/Webhook.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
+
+- *New in Dev Version 1.10.2!* _UI Updates_: Built with Material UI, a smoother, more intutive interface for enhanced user experience.
+  <kbd><img src="./ReadMeGifs/Gifs/NewUI.png" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
+
+- *New in Dev Version 1.10.2!* _Github Integration + Import/Export Workspaces_: Swell allows you to import and export workspaces, making it easy to share collections with your team. You can even register with Github to save your workspaces directly into your repository!
+  <kbd><img src="./ReadMeGifs/Gifs/GithubIntegration.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
 ## Built With
 
 - Electron
 - React
+- React Router
+- Material UI
 - Redux
 - Apollo Client
 - Websockets
@@ -111,6 +118,7 @@ Swell is a one-stop shop for sending and monitoring your API requests
 - IndexedDB
 - Chai
 - Mocha
+- Playwright
 
 ## Authors
 
@@ -167,6 +175,10 @@ Swell is a one-stop shop for sending and monitoring your API requests
 - **Sam Pyo** - [samhpyo](https://github.com/samhpyo)
 - **Drew Pomatti** - [thedrewery](https://github.com/thedrewery)
 - **Kurtis Waterbury** - [kurto8](https://github.com/kurto8)	
+- **Yale Yng-Wong** - [ywy-w](https://github.com/ywy-w)
+- **Evelin Goldin** - [evelingoldin](https://github.com/evelingoldin)
+- **Alexander Adams** - [alex-e-adams](https://github.com/alex-e-adams)
+- **Ethan Sclarsky** - [esclarsky](https://github.com/esclarsky)
 
 ## License
 

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+[ZoneTransfer]
+ZoneId=3
+HostUrl=https://files.slack.com/files-pri/T02UEDCSEJ1-F03GLHVTD6D/download/swell-gif.gif?origin_team=T02UEDCSEJ1