https://github.com/samantha-ruth/portfolio-generator

A quick template to create a personal portfolio. Uses node and npm dependencies including inquirer.
https://github.com/samantha-ruth/portfolio-generator

es6-javascript inquirerjs nodejs npm promises template-literals

Last synced: about 2 months ago
JSON representation

A quick template to create a personal portfolio. Uses node and npm dependencies including inquirer.

• Host: GitHub
• URL: https://github.com/samantha-ruth/portfolio-generator
• Owner: Samantha-Ruth
• Created: 2022-06-06T21:26:53.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-27T03:30:00.000Z (over 2 years ago)
• Last Synced: 2024-04-16T08:49:23.757Z (9 months ago)
• Topics: es6-javascript, inquirerjs, nodejs, npm, promises, template-literals
• Language: CSS
• Homepage:
• Size: 29.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Portfolio-Generator

Template to create a personal portfolio.

## Description

Professional Portfolio Generator

This project worked with node and npm dependencies to automatically generate a professional portfolio markdown document based on user input.  

This project helped me understand how to work from the command line using node.js.  To do this, I learned about the node package manager (npm), specifically the "inquirer" dependency to prompt user for information and the node file system to write new files, and I learned about Javascript ES6 language and the use of arrow functions.  I also was introduced to template literals, how to modularize the code using "require" and "module.exports", and how to refactor the code and use a promise chain.  I also learned how to destructure templateData to create variables to hold data for conditional sections (eg license), how to utilize the spread and rest operators, and how to create a function with a template literal. I also learned how to use the keyword "new" to create a promise object with resolve and reject parameters. 

## Table of Contents

* [Installation](#installation)

* [Usage](#usage)

* [Links](#links)

* [Questions](#questions)

## Installation

If the user already has node installed on their device, they can download this project and run "npm init" and then "npm install" to download the dependencies.  Next, the user should enter "node index.js" into their command line. 

## Usage

User enters "node app.js" into the command line.  The user will receive a series of prompts, asking for name, GitHub username, information for the About section, name and description, languages used, GitHub link, and whether or not the project will be featured or not.  

When the user is finished entering their information, a ReadMe.md file is created with the user's name on top, GitHub Link, about me, and projects.  The page also has a link to the GitHub at the bottom.  

![Portfolio-Generator](https://user-images.githubusercontent.com/64170123/192424516-6f903e24-255c-4bfc-b6fc-a439c0d4a3ad.png)

![Portfolio-Generator2](https://user-images.githubusercontent.com/64170123/192424527-f3ccea7a-dd98-4bae-998a-dd97e451ef4f.png)

## Links

The link to the project is here: https://samantha-ruth.github.io/README-Generator (which will show you this page)

The url of the Git repository is here: https://github.com/Samantha-Ruth/README-Generator

## Questions

If you have any questions about the repo, open an issue or you can find more of my work at (https://gitHub.com/Samantha-Ruth).