Navigate back to the homepage
AboutWeb-DevelopmentSoftware-DevSelf-Improvement
x
x
x
x
x
x
x

How to make your Résumé an NPM package

Divyansh Tripathi
February 28th, 2019 · 3 min read

It is easier than Latex, I assure you that…

What is this tutorial about?

So in this article, you are going to learn:-

  1. How to make nodejs cli (command line interface) apps.
  2. How to publish your own NPM package.

Pre-Requisites

Just a little bit of Nodejs. I’ve tried to make it as beginner friendly yet fast-paced (for amateurs who skip to code). One more very important pre-requisite would be your information as we will be creating a resume app on the command line.

All the code is available here at:-

silent-lad/silentlad
_Contribute to silent-lad/silentlad development by creating an account on GitHub._github.com

So Let’s Get Started

This Tutorial is going to consist of 2 parts.

  1. Making the cli app
  2. Publishing it as an NPM package.

Making the cli app (Part-1)

We are going to create a simple menu in cli from which the user can choose what do they want to know about us. So the list will consist of options like Past Experience, Education Qualification.

n1

For this, we will use the Inquirer.js package. It has a simple prompt-then routine which is very intuitive.

We will also use Chalk.js as I’m very obsessed with coloured console.logs

A code this short would create a question prompt in cli.

The prompt object consists of keys such as type, name etc.

For now, we need to know only 2 those will be the message(the question to be asked) and choices( the options we provide).

Structured Approach

Instead of filling the options array with each option I used a JSON to store all my resume information which can be parsed and supplied by the app.

STEP 1:-

n2

The JSON file

Write this code in a separate resume.json file and save it with your own qualifications. Please don’t use the one in this pic.

After that, we will just use the inquirer to make the question-answer format.

STEP 2:-

Name your package and install its dependencies.

1npm init

Now here be careful while giving the name field as this will be the name of your package when you upload it to the npm site. MAKE SURE IT’S UNIQUE

Now install your package dependencies i.e chalk and inquirer.

1npm i --save chalk inquirer

CLI APP

So we will give them 4 options and an option to exit and go back at the 2nd stage. Go back will just call the parent function again. Nothing so fancy. Here’s the complete app code.

STEP 3:-

Save this code in index.js.

Key Points:-

  1. #!/usr/bin/env node -This line is important as our package is going to run from cli and we need to know the environment in the script.
  2. response() function just shows my OCD with chalk module.

STEP 4:-

Test if your code works.

1node index.js

If your code doesn’t work for some reasons check with the repo link given above. If it does then, HURRAYYYY!!! You just made a cli app for your resume. You should clap for yourself.

THE NPM PACKAGE (PART-2)

Now that we have our cli app running lets’ deploy it as an NPM package.

Step 1-

Register yourself on npmjs.com. To be able to publish NPM packages you have to make an account on npmjs. Easy Step. Make the account and come back here.

Step 2-

Add a user to you npm cli tool. Now you have to link the npm cli to your npmjs account. In your terminal type

npm adduser

After that fill the prompts as requested, Example:-

n3

Username- it is you npm username.

Password- It is your npmjs account password.

STEP 3-

Making your project ready for publishing. Now add these following lines to the package.json file of your cli app. This step will make your app to be accessible directly from the command line.

  • < your package name > can be seen in the package.json under the “name” key
1"bin": {
2
3"<your package name>": "./index.js"
4
5}

STEP 4-

Add a readme.md to your project and write whatever you want to about it. This will be shown on the package page.

STEP 5-

PUBLISH THE PACKAGE. Go to the package directory, open up the terminal inside it and run

1npm publish --access=public

AND ITS DONE. You have successfully published the package.

STEP 6(Optional)-

It is optional but important to know how to update your package online. When you start with your npm project it is by default 1.0.0 and published as same. But if you need to change something in it and re-publish the new changes YOU HAVE TO UP THE VERSION by semantic versioning.

n4

If it is a patch(very small change). You run

1npm version patch

This will make your package version 1.0.1 and increment in future accordingly.

If you have done a considerable change. You run

1npm version minor

and your package will be now 1.1.0 and for a major change, you run.

1npm version major

and you now will have 2.0.0.

After that just hit npm publish and you have your package updated on npmjs.

Let’s Test It.

It works… I hope it worked out for you guys too. In your next interview do remember to show them some swag by showing your resume in an npm package on their desktop.
I have kept the app as simple as possible to just get you the idea of everything. Explore more. Have Fun.

Open for both criticism and appreciation ;)

Join my email list and get notified about new content

I promise I won't spam or unnecesarily promotional emails through this mailing list. You might also get chance to be eligible for my monthly giveaways. Also I promise to not spam your inbox or share your email with any third parties.

More articles from Silentlad

A to Z of NPM Packages

26 unconventional npm packages. 1 for each alphabet ;)

February 21st, 2019 · 4 min read

How I Became a Programmer IN SPITE of the Education System

Are you a successful and happy programmer because of your formal education or in-spite of it?

January 30th, 2019 · 4 min read
xx
© 2018–2021 SilentladSitemapRSS feed
Link to $https://twitter.com/silent_lad_Link to $https://medium.com/@silentladLink to $https://github.com/silent-ladLink to $https://www.instagram.com/silent_lad_/Link to $https://www.linkedin.com/in/silentlad/Link to $mailto:silentlad29@gmail.com