linkChek 1.0.0!

-

So this past weekend, I've finally released the CLI tool we've been working on this whole semester for its first offical release! linkChek 1.0.0 is up on npm and GitHub! Last week we were tasked by our professor for our final lab, to release our CLI program that we've been gradually working on throughout the labs for this semester and polish it up for production.

So as a Node.JS app, I had to look up how to release my program on the npm registry. The process was quite simple. I just had to edit the package.json file a little bit with info such as keywords for the npm database, final name for release, and github repo links, just to name a few. 

So I pushed my final commit on the master branch for the release, added the 1.0.0 tag and followed these instructions to publish an unscoped package up on npm website.



Now you can install and run linkChek with this command in your shell

npx linkChek

or

npm install linkChek


Here is the page on the NPM website : linkChek [https://www.npmjs.com/package/link-chek]

Here is the GitHub repo page : linkChek [https://github.com/joelazwar/linkChek]


Thanks for reading

Comments

Post a Comment

Popular posts from this blog

HacktoberFest Entry No.2

-
Image
So around last week I found a great github repo of a chrome extension that previews contents of a webpage when you hover over a link. I stumbled upon it after a suggestion from my professor about taking a look at chrome extensions for a possible repo to contribute to. I'm glad I did because this was a chrome extension that was interesting, seemed practical and had a maintainer who was keen on receiving contributions to better his program. The extension is called Survol First I had to install it and test it out first, can't just contribute to a repo meaninglessly just to force a pr. I tested the extension and liked the functionality, it was useful and is well designed. Makes it all the more exciting for me to try and contribute to it. So I read the docs and learned how the extension worked. It uses a javascript file to inject html elements through the dom and uses mousemove event to detect anchor links to request information of a page, and positions and fills the div with conten...
Read more

Lab 1 : Our First Open Source Contributions

-
So for Lab 1 our tasks were fairly simple. Find a partner to review a repo on and make contributions, no matter the scale, to their code. Be it a suggestion for their code, reporting an issue, or even fixing up small details in their readme. So through slack I partnered up with one of my coursemates  Niaz Much like me, he wrote his code in nodejs, so it was perfect since I can go through his code easier through my understanding of node. His code, though written in the same language, differed from mine a lot. For one, he didn't use yargs so he had to process the arguments manually, and secondly he didn't use fetch and opted for a module called linkinator. No problem, in fact it's an opportunity for me to understand the logic and components that he used. I forked a copy of the repo, cloned it and tested it out for myself. The code worked perfectly as intended and processed urls well. Functionally, I couldn't find find anything in the code I could identify as a flaw or imp...
Read more

Hack.... vemberfest.. PR No. 3

-
Image
OK so this is pretty long overdue (sorry Prof!) And I still have one more pull request to go and that's on me yes. BUT, this week I spent working (or should I say learning) on our course's aggregated blog website which coincidentally, our prof is making us work on this week for the lab, so I guess I got a good head start going on.  So I took on an issue that seemed pretty straight forward in the repo. It was to change the functionality of the search bar when filtered by author. Seemed pretty straightforward enough, so I went ahead, forked the repo and cloned it on my computer. Now the reading begins, the lengthy process of coding. And the fact that this was a whole website coupled with different technologies that I'm not familiar with only made it waaayyy longer, which maybe is a sign that I should have started working on this much much earlier. But that's what happens when your time management skills is hot garbage. Anyways, I spent the next few days learning about eac...
Read more