search

alanshaw / david-www

:eyeglasses: David helps keep your Node.js project dependencies up to date.
https://david-dm.org
MIT License
730 stars 131 forks source link

First steps #396

Closed johnjohndoe closed 6 years ago

johnjohndoe commented 6 years ago

What are the first steps to get david-dm running for a GitHub project?

  1. Visit http://david-dm.org
  2. Click Sign in link in the top left, page updates accordingly
  3. Nothing happens?!, there is no links to select a project to monitor
South-Paw commented 6 years ago

Hi there, unsure if you're still stuck but figured I'd answer anyways...

There isn't really any setup steps... you just add some bits to the david URL for your Github project.

The project of course needs to be a Node.js project with a valid package.json in it's root - david will do the rest after you visit your projects URL.

For example, here's the URL to one of my projects; https://david-dm.org/South-Paw/discord-music-bot

Badges (for your readme and such) can be retrieved by adding .svg to the end of the URL:; https://david-dm.org/South-Paw/discord-music-bot.svg

Hope that helps.

johnjohndoe commented 6 years ago

Thank you - this helps. I recommend you put this explanation in the README since it was not obvious to me how to start. Other than that the issue can be closed.

alanshaw commented 6 years ago

Would one of you send a PR?

South-Paw commented 6 years ago

@alanshaw I don't think you need a PR at all as this is already there in the README...

The example usage right there:

image

And as the project description states;

Node.js based web service that tells you when your project npm dependencies are out of date.
To use David, your project must include a package.json file in your repository.

So both of what I stated above.

Sorry, but I honestly just think that the reporter didn't bother to read any of it before creating this issue