remcodex 0.1.0-beta.1 → 0.1.0-beta.2
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 +16 -25
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -142,31 +142,34 @@ This project is currently developed primarily around a local macOS workflow.
|
|
|
142
142
|
|
|
143
143
|
## Quick Start
|
|
144
144
|
|
|
145
|
-
For the current
|
|
145
|
+
For the current beta, the fastest way to try RemCodex is:
|
|
146
146
|
|
|
147
147
|
```bash
|
|
148
|
-
|
|
149
|
-
npm run build
|
|
150
|
-
npm link
|
|
151
|
-
remcodex start
|
|
148
|
+
npx remcodex
|
|
152
149
|
```
|
|
153
150
|
|
|
154
|
-
|
|
151
|
+
You can also install it globally:
|
|
155
152
|
|
|
156
|
-
```
|
|
157
|
-
|
|
153
|
+
```bash
|
|
154
|
+
npm install -g remcodex
|
|
155
|
+
remcodex
|
|
158
156
|
```
|
|
159
157
|
|
|
158
|
+
RemCodex starts a local server and opens the browser for you.
|
|
159
|
+
|
|
160
160
|
If you want to make it reachable from your phone, expose the local machine on your LAN and open the same URL with your host IP.
|
|
161
161
|
|
|
162
162
|
## Local CLI
|
|
163
163
|
|
|
164
|
-
RemCodex
|
|
164
|
+
RemCodex also works well from source if you want to develop locally or inspect the runtime setup.
|
|
165
165
|
|
|
166
|
-
|
|
166
|
+
Local development path:
|
|
167
167
|
|
|
168
168
|
```bash
|
|
169
|
-
|
|
169
|
+
npm install
|
|
170
|
+
npm run build
|
|
171
|
+
npm link
|
|
172
|
+
remcodex start
|
|
170
173
|
```
|
|
171
174
|
|
|
172
175
|
Useful commands:
|
|
@@ -184,12 +187,6 @@ node dist/server/src/cli.js start --db ~/.remcodex/remcodex-alt.db --no-open
|
|
|
184
187
|
node dist/server/src/cli.js doctor --db ~/.remcodex/remcodex-alt.db
|
|
185
188
|
```
|
|
186
189
|
|
|
187
|
-
Planned install target after the npm package is published:
|
|
188
|
-
|
|
189
|
-
```bash
|
|
190
|
-
npx remcodex
|
|
191
|
-
```
|
|
192
|
-
|
|
193
190
|
## Development
|
|
194
191
|
|
|
195
192
|
```bash
|
|
@@ -306,7 +303,7 @@ This is the honest list:
|
|
|
306
303
|
- no production-grade auth / multi-user hardening yet
|
|
307
304
|
- no release pipeline yet
|
|
308
305
|
|
|
309
|
-
If you are comfortable
|
|
306
|
+
If you are comfortable running a local Node app or a small CLI tool, you can use it today.
|
|
310
307
|
|
|
311
308
|
## Roadmap
|
|
312
309
|
|
|
@@ -320,12 +317,6 @@ Near-term:
|
|
|
320
317
|
|
|
321
318
|
Later:
|
|
322
319
|
|
|
323
|
-
-
|
|
320
|
+
- improve the first-run install and update experience
|
|
324
321
|
- optional sync / multi-device helpers
|
|
325
322
|
- stronger sharing, auditing, and team workflows
|
|
326
|
-
|
|
327
|
-
## License
|
|
328
|
-
|
|
329
|
-
No license has been added yet.
|
|
330
|
-
|
|
331
|
-
Until a license is added, assume this repository is **source-available for review only**, not open source for reuse.
|