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

docs: add npm install to getting started instructions #553

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sentience
Copy link
Contributor

No description provided.

@paulrobertlloyd
Copy link
Collaborator

Hi @sentience; npm install shouldn’t be needed; using npm create indiekit [directory] will install the required dependencies as part of that initiation process (you will be asked to download and install create-indiekit if I remember correctly).

Did you try this, or did it not work?

@sentience
Copy link
Contributor Author

Doesn't work for me. This is what I get with a fresh clone:

❯ npm create indiekit indiekit
sh: create-indiekit: command not found
npm ERR! code 127
npm ERR! path /Users/kyank/code/indiekit
npm ERR! command failed
npm ERR! command sh -c -- create-indiekit indiekit

npm ERR! A complete log of this run can be found in:
npm ERR! /Users/kyank/.npm/_logs/2022-12-26T11_26_16_970Z-debug-0.log

@paulrobertlloyd
Copy link
Collaborator

paulrobertlloyd commented Dec 26, 2022

That's odd. What versions of npm and node are installed?

@sentience
Copy link
Contributor Author

❯ node --version
v18.12.1

❯ npm --version
8.19.2

@rmdes
Copy link

rmdes commented Jun 20, 2023

I had to npm install prior to being able to do npm create indiekit (directory)

@paulrobertlloyd
Copy link
Collaborator

Interesting. I'm not sure that's how npm initialisation packages are meant to work (requiring npm install beforehand) but maybe I'm missing something. Will investigate!

@paulrobertlloyd
Copy link
Collaborator

Am finding this issue hard to replicate.

When I type the following:

npm create indiekit my-project

I get the following:

Need to install the following packages:
  [email protected]
Ok to proceed? (y) 

That package is installed, before the question flow starts. After answering the questions, the directory and files are created. I’ve deleted all npm caches and reinstalled Node.

Note, this command should be run independent of cloning any repo or any other setup. What steps did you follow? How did you install Node? What platform are you using? This one has me stumped at the moment…

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core indiekit package documentation Good documentation benefits everyone question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants