vzcode 0.4.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -5
- package/dist/assets/index-41607816.js +89 -0
- package/dist/assets/index-8bac68c9.css +1 -0
- package/dist/index.html +16 -2
- package/package.json +29 -19
- package/src/{App.jsx → client/App.tsx} +83 -126
- package/src/client/Sidebar/DirectoryArrowSVG.jsx +5 -0
- package/src/client/Sidebar/DirectoryListing.tsx +76 -0
- package/src/client/Sidebar/FileListing.tsx +42 -0
- package/src/client/Sidebar/Item.jsx +43 -0
- package/src/client/Sidebar/Listing.tsx +44 -0
- package/src/client/Sidebar/index.tsx +80 -0
- package/src/client/Sidebar/styles.scss +84 -0
- package/src/client/Sidebar/useOpenDirectories.ts +37 -0
- package/src/{diff.js → client/diff.js} +1 -1
- package/src/client/featureFlags.js +3 -0
- package/src/client/getFileTree.ts +52 -0
- package/src/{getOrCreateEditor.js → client/getOrCreateEditor.js} +6 -6
- package/src/{json1PresenceDisplay.js → client/json1PresenceDisplay.js} +0 -1
- package/src/client/settings.jsx +97 -0
- package/src/client/sortFileTree.ts +19 -0
- package/src/client/style.scss +93 -0
- package/src/server/computeInitialDocument.js +69 -0
- package/src/server/featureFlags.js +4 -0
- package/{cli.js → src/server/index.js} +24 -30
- package/src/types.ts +57 -0
- package/dist/assets/index-48dbd5c3.js +0 -89
- package/dist/assets/index-8d2d4b3b.css +0 -1
- package/src/settings.jsx +0 -141
- package/src/style.css +0 -215
- /package/src/{CodeEditor.jsx → client/CodeEditor.jsx} +0 -0
- /package/src/{json1PresenceBroadcast.js → client/json1PresenceBroadcast.js} +0 -0
- /package/src/{main.jsx → client/main.jsx} +0 -0
package/README.md
CHANGED
|
@@ -4,6 +4,23 @@ Multiplayer code editor system | [Kanban](https://github.com/orgs/vizhub-core/pr
|
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
|
|
7
|
+
## Development
|
|
8
|
+
|
|
9
|
+
To get set up locally, run:
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
cd vzcode
|
|
13
|
+
npm install
|
|
14
|
+
npm run test-interactive #This starts the server
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Once the server is running, you can get hot reloading (of the client only) with:
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
npm run dev
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
7
24
|
## Features
|
|
8
25
|
|
|
9
26
|
This project is nascent but has enough features to actually use, a minimum viable product (MVP):
|
|
@@ -48,6 +65,32 @@ This can be done introducing a new npm script and dependency like this:
|
|
|
48
65
|
|
|
49
66
|
Then run `npm run edit` to start the editor.
|
|
50
67
|
|
|
68
|
+
# Host Server With Ngrok
|
|
69
|
+
|
|
70
|
+
How to host your VZCode session with Ngrok. Hosting with Ngrok will allow users that are not on your network to join your session.
|
|
71
|
+
|
|
72
|
+
## Host With Ngrok Globally Installed
|
|
73
|
+
|
|
74
|
+
- Warning - This will only work if you have an Ngrok account and your machine is authenticated
|
|
75
|
+
|
|
76
|
+
To host Ngrok, first set up a VZcode instance by moving into your directory, then in the terminal run
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
vzcode
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Next while the local host session is running, in the terminal run
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
ngrok http 3030
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
This will give you a link that can be shared to collaborators who then can join from anywhere.
|
|
89
|
+
|
|
90
|
+
## Host With Ngrok Through VZCode
|
|
91
|
+
|
|
92
|
+
Coming Soon
|
|
93
|
+
|
|
51
94
|
### Staging Site Editor
|
|
52
95
|
|
|
53
96
|
[Experimental idea]
|
|
@@ -106,12 +149,12 @@ March 2023
|
|
|
106
149
|
- [x] UX for adding new files, renaming files, deleting files
|
|
107
150
|
- [x] Implement presence (the ability to see the cursors of others in real time)
|
|
108
151
|
- [x] Publish an early release to NPM
|
|
109
|
-
- [
|
|
152
|
+
- [x] Test out how it works using tunneling services such as NGrok
|
|
110
153
|
|
|
111
154
|
April 2023
|
|
112
155
|
|
|
113
|
-
- [
|
|
114
|
-
- [
|
|
156
|
+
- [x] Add support for nested directories, including:
|
|
157
|
+
- [x] Develop a tree-based sidebar UI allowing directory navigation
|
|
115
158
|
- [ ] Dogfood the product and try to collaboratively develop something, maybe a data visualization
|
|
116
159
|
- [ ] Gather feedback from early users and iterate based on that
|
|
117
160
|
- [ ] Publish a YouTube video presentation of the work to date
|
|
@@ -119,8 +162,7 @@ April 2023
|
|
|
119
162
|
## Team
|
|
120
163
|
|
|
121
164
|
- Curran Kelleher
|
|
122
|
-
-
|
|
123
|
-
- Additional external collaborators, TBD
|
|
165
|
+
- Anooj Pai from [RPI RCOS](https://rcos.io/)
|
|
124
166
|
- Contributions welcome!
|
|
125
167
|
|
|
126
168
|
## Spaces
|