portfolio-generator

By B2BChewy * Email me *

• Walkthrough-video Link
  
  

Description

A command-line application that dynamically generates a portfolio from a user's input using the Inquirer package (Links to an external site.)

Table of contents

• Description
• Installation Instructions
• Usage Instructions
• Questions
• Contributing
• Tests
• License

Description

Back to Table of Contents

This application was built in aim to provide a way to quickly and easily create portfolios. Coding takes a lot of time, hence the idea for this application. I have learnt using the 'inquirer' for prompting my users for their input by answering listed questions. It is fun and easy to use.

User Story

Back to Table of Contents

AS A developer I WANT a portfolio-generatorfw * SO THAT users can quickly create portfolios * GIVEN a command-line application that accepts user input * WHEN I am prompted for information about my application repository * THEN a portfolio is generated with the * title and sections

Installation Instructions

Back to Table of Contents

• Requirements
  • User needs to have npm package installed and terminal/bash or VSCode available
• Step 1:

• npm install

• Step 2:

• npm start

• Step 3:

• Asnwer question prompts in terminal Step 4:

• Open your generated portfolio file located in dist directory(within Develop directory)

  Usage Instructions

  Back to Table of Contents

  This project is used for easy and quick portfolio creating

  • Requirements

• User needs to have npm package installed and terminal/bash or VSCode available

  • Step 1:
    • npm install

• (You have to be in Develop folder when running the app)
  • Step 2:
    • node run index.js

  

• Step 3:

  • Answer question prompts in terminal.
  • Once you answer all questions, your portfolio will be generated.

  

• Step 4:
  • Open your generated portfolio file located in dist directory(within Develop directory).
  • You can edit this file by removing/adding sections and/or images or other links.

Contributing

Back to Table of Contents

Others are welcome to contribute, respecting the license which this project is listed under

Tests

Back to Table of Contents

1. testPortfolio.md
2. testPortfolio1.md

Questions

Back to Table of Contents

• If you have any questions, please Email me

License

Back to Table of Contents

• License Type: MIT License: MIT Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This README was generated by B2BChewy with ❤️ GitHub Profile