Npm Resume

For this exercise we're going to create our own npm package that will print out your resume. the cool thing about this is that anyone can install your code and print out a resume from their console!

Instructions

You do not have the necessary rights to update this repository. Therefore, you must make a personal copy, or fork, make changes to your fork, and then send a pull request to the owners of this repository. When working with github classroom , github creates this fork exclusively through using the link provided by the instructional team. To successfully complete the assignment:

1. accept the github classroom invitation.
2. clone this repository.
3. Change into the new directory.
4. Fulfill the listed requirements.

When you have fulfilled the requirements below, make a pull request on this repository to turn in your work.

If you do not complete the assignment in the allotted time, submit any and all work so we can evaluate your participation.

Steps

1. Go ahead and create/change into a new directory called resume in your exercises or sandbox folder.

2. In order to publish anything to npm, we have to sign up/login with npm.

   • You can type npm whoami to see if npm recognizes you as logged in. (Most likely you are not)
   • To sign up, I recommend going to their site npmjs.
   • Login to your account my typing npm login in your terminal and following the prompts.
   • You will also need to verify your email account.
   • Run npm whoami again to ensure you are now logged in.

3. Once you've signed up, type in npm init to create a package.json file. The only two required fields are name and version

   • The package name should be something like yourname-resume (You have to pick a name that hasn't been taken - you can search npm's site to see what's available)
   • Version should follow this format x.x.x (I recommend putting 1.0.0)
   • Enter a Descripition, or press enter to skip.
   • For test_command and entry_point you can just hit enter.
   • For license, you can use ISC
   • Fill in the rest fields the best you can. It's ok if you don't know what to put. You can just hit enter, and you can always edit everything later.

4. Now create 3 files - index.js, readme.md, info.json

5. On the first line of index.js add...

#! /usr/bin/env node

This is a little strange looking, but will allow us to run our code globally as well as from the command line later.

For more info on the Shebang

6. Next add...

const fs = require('fs')

fs.readFile(__dirname + '/info.json', 'utf8', function(err, data) {
    if (err) {
        console.log(err)
    } else {
        console.log(data)
        return data
    }
})

• fs (short for File System) is part of node that we are bringing in to allow us to more easily and reliably read what directory we are in.
• __dirname is the directory we are currently in
• readFile gives us back the contents of a file. We are passing in 3 arguments...
  • the file we want to read
  • the way to encode that file
  • a callback function
    • if there is an error getting the file, print the error, else, print out and return the content.

7. Next add the following to your package.json file. We're adding in a command that someone who's downloaded your npm file can run to display your resume.

"bin": {
    "your-command-here": "./index.js"
  },

Hard part over!!

8. In info.json create a json object that's a short resume for yourself.

Note: json wants property names and strings to be wrapped in "double quotes"! There are a few other differences as well that separate it from a javascript object You can use my resume as a guide. Yours can be shorter, or sillier, whatever you want! Feel free to add in more properties like interests, soft-skills, pets, etc...

{
    "name": "Hammad Malik",
    "website": "https://tomatohammado.github.io/",
    "linkedin": "https://www.linkedin.com/in/tomatohammado/",
    "github": "tomatohammado",
    "email": "[email protected]",
    "resume": "https://tomatohammado.github.io/assets/Malik-Hammad-Resume.pdf",
    "proficientTechnologies": [
        "Javascript",
        "React",
        "Vue",
        "Node",
        "Express",
        "Mongodb",
        "PostgreSQL",
        "Python",
        "Django",
        "Wordpress",
        "Drupal"
    ],
    "otherSkills": [
        "Unagi",
        "Five Finger Fillet",
        "Bridge"
    ]
}

9. Update your readme to be a short description about what you've made

10. git init, add, and commit.

    • Then create a new github repository
    • Link your local file to the github repository (use git remote add origin <https key here> and make sure to use HTTPS not SSH)
    • push up your changes!

11. Ok, finally - run npm publish

    • You should be able to see your site and your readme on the npmjs site under your profile.

    To update you can just call npm publish again, but you first need to change the version number in your package.json!

12. To test that everything worked, change into a different directory and run npm i -g name-of-project. The -g flag installs the package globally instead of in the current directory. If you get permission errors, add the sudo command and run sudo npm i -g name-of-project but be carefully when running commands using sudo because that gives the command full permissions. Then run your-command-here

    • You can also download each other's npm resumes and print them out!

13. To turn in this assignment please paste a link to the GitHub repository your have created for this.

<Your link here>

🌟BONUS!🌟

• Checkout Color.js to make your resume different colors!
• Use JSON.parse to create your resume as a javascript object you can loop through and customize more!

License

1. All content is licensed under a CC­BY­NC­SA 4.0 license.
2. All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact [email protected].

Short description about what I have made.

I added index.js and added fs.readFile function. Then I added info.json that is a short resume for myself.