Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve developer getting started experience #130

Closed
marstamm opened this issue Jun 16, 2022 · 6 comments · Fixed by #131
Closed

Improve developer getting started experience #130

marstamm opened this issue Jun 16, 2022 · 6 comments · Fixed by #131
Assignees

Comments

@marstamm
Copy link

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 added a commit that referenced this issue Jun 16, 2022
@nikku nikku mentioned this issue Jun 16, 2022
@nikku
Copy link
Owner

nikku commented Jun 16, 2022

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

@nikku
Copy link
Owner

nikku commented Jun 16, 2022

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
Copy link
Owner

nikku commented Jun 16, 2022

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):

image

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

nikku added a commit that referenced this issue Jun 16, 2022
@nikku
Copy link
Owner

nikku commented Jun 16, 2022

#132 bumps to node-sass@7 so we're in principle supporting node>14 environments.

nikku added a commit that referenced this issue Jun 16, 2022
@marstamm
Copy link
Author

Awesome, thanks for looking into this so quickly ❤️

@nikku
Copy link
Owner

nikku commented Jun 16, 2022

Thanks for opening this issue ❤️

@nikku nikku self-assigned this Jun 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants