Add comprehensive installation and setup documentation

- Add GETTING_STARTED.md with quick start guide and development modes
- Add INSTALL.sh automated installation script
- Add INSTALLATION_CHECKLIST.md, INSTALLATION_SUCCESS.md, and INSTALLATION_SUMMARY.md
- Add QUICK_REFERENCE.md for common commands
- Add SETUP_GUIDE.md with detailed setup instructions
- Update README.md with improved project overview
- Add did-wallet app dependencies and node_modules
This commit is contained in:
Dorian
2026-01-27 17:18:21 +00:00
parent a81f655133
commit 0d073fa89e
22658 changed files with 4494151 additions and 6 deletions
+21
View File
@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2018 Zejin Zhuang <heineiuo@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+59
View File
@@ -0,0 +1,59 @@
# isomorphic-ws
Isomorphic implementation of WebSocket.
It uses:
- [ws](https://github.com/websockets/ws) on Node
- [global.WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) in browsers
## Limitations
Before using this module you should know that
[`ws`](https://github.com/websockets/ws/blob/master/doc/ws.md#class-websocket)
is not perfectly API compatible with
[WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket),
you should always test your code against both Node and browsers.
Some major differences:
- no `Server` implementation in browsers
- no support for the constructor
[`options`](https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketaddress-protocols-options)
argument in browsers
## Usage
You need to install both this package and [ws](https://github.com/websockets/ws):
```
> npm i isomorphic-ws ws
```
Then just require this package:
```js
const WebSocket = require('isomorphic-ws');
const ws = new WebSocket('wss://echo.websocket.org/');
ws.onopen = function open() {
console.log('connected');
ws.send(Date.now());
};
ws.onclose = function close() {
console.log('disconnected');
};
ws.onmessage = function incoming(data) {
console.log(`Roundtrip time: ${Date.now() - data.data} ms`);
setTimeout(function timeout() {
ws.send(Date.now());
}, 500);
};
```
## License
[MIT](LICENSE)
+17
View File
@@ -0,0 +1,17 @@
// https://github.com/maxogden/websocket-stream/blob/48dc3ddf943e5ada668c31ccd94e9186f02fafbd/ws-fallback.js
var ws = null
if (typeof WebSocket !== 'undefined') {
ws = WebSocket
} else if (typeof MozWebSocket !== 'undefined') {
ws = MozWebSocket
} else if (typeof global !== 'undefined') {
ws = global.WebSocket || global.MozWebSocket
} else if (typeof window !== 'undefined') {
ws = window.WebSocket || window.MozWebSocket
} else if (typeof self !== 'undefined') {
ws = self.WebSocket || self.MozWebSocket
}
export default ws
+8
View File
@@ -0,0 +1,8 @@
// Type definitions for isomorphic-ws
// Run `npm install @types/ws` before using this.
// Fix for https://github.com/heineiuo/isomorphic-ws/issues/8
// If there is still something wrong, welcome issue.
import WebSocket = require('ws')
export = WebSocket
+3
View File
@@ -0,0 +1,3 @@
"use strict";
module.exports = require('ws');
+35
View File
@@ -0,0 +1,35 @@
{
"name": "isomorphic-ws",
"version": "5.0.0",
"description": "Isomorphic implementation of WebSocket",
"main": "node.js",
"types": "index.d.ts",
"browser": "browser.js",
"repository": {
"type": "git",
"url": "git+https://github.com/heineiuo/isomorphic-ws.git"
},
"keywords": [
"browser",
"browsers",
"isomorphic",
"node",
"websocket",
"ws"
],
"author": "@heineiuo",
"license": "MIT",
"bugs": {
"url": "https://github.com/heineiuo/isomorphic-ws/issues"
},
"homepage": "https://github.com/heineiuo/isomorphic-ws#readme",
"peerDependencies": {
"ws": "*"
},
"files": [
"index.d.ts",
"node.js",
"browser.js",
"README.md"
]
}