Skip to content

This Application allows you to generate your Github Profile in a pdf form and send the generated file to your inbox.

Notifications You must be signed in to change notification settings

alok463/GithubProfileGenerator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Table of contents

General info

This Application allows you to generate your Github Profile in a pdf form and send the generated file to your inbox.

  • The application is a command line application wherein it prompts the user to input his Github User name and also his email ID.
  • Upon recieving the User's Input the application creates directory to output the profile in a HTML format.
  • Furthermore the application picks the index.html from the directory and converts to a PDF file and sends the converted PDF file to the User's email. After its successful run, the application deletes the created directories and exits.

Technologies

I used the following Node libraries to create this project

  • Nodemailer (To send email and attachments to the User's Inbox)
  • Puppeteer (For Converting index.html to PDF files)
  • fs modules (File System Modules for creating and removing directories)
  • axios (To data request to an external API)
  • Inquirer (For making input prompts)

Things that I learnt during the course of this project

  • Promises and Async/Await Concepts
  • FS modules, axios and nodemailer

Setup

To run this project locally on your machine follow the below mentioned steps

$ mkdir newFolder
$ cd newFolder
$ git clone https://github.com/alok463/GithubProfileGenerator.git
$ touch .dotenv
$ add the your email and password inside .dotenv file
$ del package-lock.json
$ npm install --force
$ npm start

About

This Application allows you to generate your Github Profile in a pdf form and send the generated file to your inbox.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published