search

ljharb / repo-report

CLI to list all repos a user has access to, and report on their configuration in aggregate.
MIT License
24 stars 11 forks source link

Update the readme along with setup instructions #49

Closed CapriciousRebel closed 2 years ago

CapriciousRebel commented 2 years ago

The following Line in readme asks to run a command that involves ./src/index.js file, which does not exist in the repository. I used the following steps to try and set up the repository:

  1. clone the repo and cd into it
  2. run npm install to install dependencies
  3. generated a personal access token with :repo scope
  4. created a .env file with GH_TOKEN=<mytoken>
  5. executed ./bin/run

Now I am able to get the list of my repos in the terminal, but I ran the binary(actually a nodeJS script) to do this as there was no src/index.js file, I feel this must be wrong, or at least there must have been a start command in package.json which would run the correct file

CapriciousRebel commented 2 years ago

I would appreciate if anyone could help me out here and confirm if my steps were right, and if they were not, what are the right steps to follow in this case, I would also make a PR to update the readme with the setup instructions

ljharb commented 2 years ago

You're right :-) the readme should be for users, not contributors, so it should tell them to run npx repo-report - the src/index filename predates a lot of code review.

Contributors need to run ./bin/run. npm start is only for development, not consumers, and it'd cause some other complications if we tried to use that in dev.

In both cases, a $GH_TOKEN env var needs to be available (or provided explicitly on the command line)