slate-yjs-example
slate-yjs-example copied to clipboard
Please add Prerequisites section in README.md
Hi! Thanks for this awesome project!
I've needed to execute:
npm install --save-dev cross-env
No idea what else I have already installed and therefore did not notice as required.
Hi stippi,
thanks for this issue. cross-env is listed as a dependency so it should have been installed alongside the other dependencies during yarn/npm install. Maybe something went wrong during the install process?
Sorry if this is a dumb question, but what do you mean by "during yarn/npm install"? I cloned the repo and the immediate next thing I tried was npm run start:server from the Usage section.
JFYI: I know what npm, yarn, node.js and so on are in principle, but I have very, very little experience with the whole JS universe.
Ahh got you, no worries. You have to run npm install first which will download and install all required dependencies. After that you can npm run start:server and npm run start:cra in a separate terminal.
Let me know if that works for you!
It already worked for me after I ran npm install --save-dev cross-env. So I guess what I am saying is that you could mention the need to run npm install in your README.md, as first sentence of the Usage section.
(Unless this is really dumb and everyone except me already knows this? Then feel free to close, of course. ;-)