Setup instructions in README from step 6 no longer work

[Scihat]

Discussed in #137

^{Originally posted by Scihat August 1, 2022}
Hi,

I'm interested in volunteering for this project and was first trying to setup a local dev environment using the README.md instructions.

Note that while I am a sr. software dev, I have no experience with any of this node.js stuff. I work in industrial automation (mainly C++/Qt/python) with limited web experience (python flask). I am motivated to learn though because this is not just any project.

The setup steps are failing from here:
6. Install vercel globally:

yarn global add vercel

This returns Usage Error: The 'yarn global' commands have been removed in 2.x - consider using 'yarn dlx' or a third-party plugin instead

... so I comply and instead use:

yarn dlx vercel

... it seems to work, but an account is required on vercel, this is not mentioned in the instructions.
I signed up for a vercel free account with my new anonymous github account and imported my forked github repo into vercel. I was able to deploy successfully using the vercel web interface.

As for 'yarn global' being deprecated, In this relevant discussion on the yarn github a maintainer advises to include the package in the project unless this is just a one-off script. A user mentioned falling back to npm for global packages. 'npm i -g vercel' Not sure which option to go for, but I went for adding vercel to the dev dependencies like this:

yarn add vercel --dev

I could then do:

npx vercel

... and it deployed from the command line.

The last README instruction for a local server also fails:

vc dev

... gives a vc: command not found. I have no idea where the vc command should be coming from.
Running a local server was possible with npx yarn dev

I found that vercel itself states it does not support yarn 2 fully, only static builds'

Summary:

• step 6 in the readme is no longer valid. Either change to install vercel as project dev package or use npm to install globally
• instructions regarding vercel account are missing, but is using vercel required actually?
• The last step vc dev does not work here - but npx yarn dev does.

~ Scihat