Updating DLCheck Release

Back then when DLCheck had very limited functionalities and features, I decided to release the project and hosted it on npm, that was probably not a good idea because the project was incomplete and needed more features and test. Today, I have pushed 4 versions in total and I am happy with how much I have added to the tool.

Steps I took to push to release to NPM:
    - Go to package.json.
    - Give project a name, a main entry point and bin (mine is index.js).
    - Give project a version number, this will be the version number showing on npm after you push it.
    - Register an account on npmjs.com.
    - In the command line, run "npm publish" command, it will ask you to log in using the account you just       registered.

I asked a friend of mine who is also a programming student to follow my README in order to install the DLCheck npm package on his end and test the tool, the process was smooth since he has experience with NodeJS and had no problem following the instructions, this is great because it means that the README is clear on how to install the tool.

To install DLCheck tool using npm:
    - Make sure to have NodeJS installed.
    - Run the command "npm install dlcheck -g".
    - If you want to know the usage of the tool, check out the documentation.


DLCheck Project Repository: https://github.com/Wei-J-Huang/dlcheck

Comments

Post a Comment

Popular posts from this blog

Working on the Telescope Project

Image
Two weeks ago, I've had my first chance of working with the Telescope project and utilized it's back-end API to work with my DLCheck Project. In the past few days, I got more involved, played around and worked with Telescope's front-end portion. One of the issues that I found in the project repository got an idea from the Node.js webpage and requested for a React Component to display the contributors' information to thank them for their effort in developing/maintaining the Telescope project. In the beginning, I was a bit lost by reading the existing code, but luckily, the telescope project was developed using the React JS library and utilizes Material-UI framework, I have worked with a project which was also developed using the same tools during my Release 0.2 assignment, therefore, I was able to understand pieces of codes fairly quick. The new Card Component was overall not that hard to implement but it still took me a quite bit of time, I was given a custom React Hook...
Read more

Hacktoberfest -1

 This week the Hacktoberfest event has finally started and I had the chance to contribute to real open source projects. Finding an issue that I can fix took way longer than I thought it would, most of the issues were either taken or they were too complicated for a first time contributor. After a while of searching around GitHub repos with "good-first-issue" labels applied, I found a couple repositories that seemed interesting to me. One of the repositories requested for a new URL redirects in their projects, I thought this was an easy fix, but that it was more complicated than I thought it would be, the original repository had no instruction on how to run and test the application, therefore, I had to leave a comment in the issue asking for instructions. As it turns out a test must be written first before adding any code to the project, and when I ran the initial test before adding anything into the project, I was already getting testing errors, it seems like a challenging one...
Read more

Hacktoberfest -2

 Hacktoberfest is still ongoing, this week I have made my second contribution to real open source projects, I have decided to go with the same method I used last time to look for issues, which was applying the "hacktoberfest" label and sorting by the issue post date. After a bit of browsing, I decided to pick up an issue from a small project. It is a weekly calendar app developed using a JavaScript front-end frame work called Svelte, the issue indicates that the project could use a clipboard icon on their web app and an click event handler to allow users to copy contents to the clipboard. This project was easy to set up and configure for testing, since I already have most of the tools required to work with it, all I had to do was to install the dependencies and get it running locally by using the "npm run dev" command. Thanks to the project owner who posted the issue, he specified the exact file to add the feature to, which was very helpful, without the instructions...
Read more