websocket-king/README.md

44 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2021-06-16 14:09:26 +01:00
# Websocket King
## About
WebSocket King is a a tool designed to assist in developing and debugging WebSocket connections.
- Website - https://websocketking.com
- Chrome Extension - https://chrome.google.com/webstore/detail/cbcbkhdmedgianpaifchdaddpnmgnknn
![Banner](public/images/banner-small.png)
## Development
1. Clone project
2. `cp .env.dev.example .env.dev`
3. `yarn start`
## Production
### `yarn build:chrome`
Builds the app for production (Chrome Extension) to the `build` folder.<br />
It correctly bundles React in production mode and optimizes the build for the best performance.
### `yarn build:web`
Builds the app for production (web) to the `build` folder.<br />
It correctly bundles React in production mode and optimizes the build for the best performance.
### `yarn build:electron`
BETA. Builds the app for production (Electron) to the `build` folder.<br />
It correctly bundles React in production mode and optimizes the build for the best performance.
### `yarn eject`
**Note: this is a one-way operation. Once you `eject`, you cant go back!**
If you arent satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point youre on your own.
You dont have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldnt be useful if you couldnt customize it when you are ready for it.