vzcode 0.5.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 CHANGED
@@ -4,6 +4,23 @@ Multiplayer code editor system | [Kanban](https://github.com/orgs/vizhub-core/pr
4
4
 
5
5
  ![image](https://user-images.githubusercontent.com/68416/224690259-293c75c5-5970-4066-80e4-b9dee568e10d.png)
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):
@@ -132,12 +149,12 @@ March 2023
132
149
  - [x] UX for adding new files, renaming files, deleting files
133
150
  - [x] Implement presence (the ability to see the cursors of others in real time)
134
151
  - [x] Publish an early release to NPM
135
- - [ ] Test out how it works using tunneling services such as NGrok
152
+ - [x] Test out how it works using tunneling services such as NGrok
136
153
 
137
154
  April 2023
138
155
 
139
- - [ ] Add support for nested directories, including:
140
- - [ ] Develop a tree-based sidebar UI allowing directory navigation
156
+ - [x] Add support for nested directories, including:
157
+ - [x] Develop a tree-based sidebar UI allowing directory navigation
141
158
  - [ ] Dogfood the product and try to collaboratively develop something, maybe a data visualization
142
159
  - [ ] Gather feedback from early users and iterate based on that
143
160
  - [ ] Publish a YouTube video presentation of the work to date
@@ -145,8 +162,7 @@ April 2023
145
162
  ## Team
146
163
 
147
164
  - Curran Kelleher
148
- - Students from [RPI RCOS](https://rcos.io/)
149
- - Additional external collaborators, TBD
165
+ - Anooj Pai from [RPI RCOS](https://rcos.io/)
150
166
  - Contributions welcome!
151
167
 
152
168
  ## Spaces