Improve developer getting started experience

[marstamm]

Hi, I just wanted to share my pain after trying to get a dev setup running. Here are my findings on what we should improve.

What should we do?

• Mention which Node version is required to run it (Node 14, as it turns out). Node 12 failed, as the Nullish coalescing operator is not supported yet Node 16 failed, as node-sass@5 only works up to Node@15

• The first time setup using npx wuffle is not working. It fails with

  ERROR (wuffle:run): [@octokit/auth-app] appId option is required
  Error: [@octokit/auth-app] appId option is required

  Even with an appId and a private key, I just gave up after Probot The contents of "env.PRIVATE_KEY" could not be validated.

Why should we do it?

Makes it less frustrating to use and hack the project.

I would also like a setup to work on the frontend without having to setup a github bot, but I understand that this might not be a valid use-case.

[nikku]

Thanks for opening this issue. I can reproduce the appId option is required one. It is fixed via #131.

[nikku]

Even with an appId and a private key, I just gave up after Probot The contents of "env.PRIVATE_KEY" could not be validated.

Given that fix the setup works just fine and you'll end up with a valid app (that is locally set up) in no time.

[nikku]

Mention which Node version is required to run it (Node 14, as it turns out).

This is already encoded in the packages (https://github.com/nikku/wuffle/blob/master/packages/app/package.json#L71, https://github.com/nikku/wuffle/blob/master/package.json#L32):

However I agree that it should work with Node 16+ at least.

[nikku]

https://github.com/nikku/wuffle/pull/132 bumps to node-sass@7 so we're in principle supporting node>14 environments.

[marstamm]

Awesome, thanks for looking into this so quickly ❤️

[nikku]

Thanks for opening this issue :heart: