Skip to content

Latest commit

 

History

History
132 lines (100 loc) · 6.33 KB

README.md

File metadata and controls

132 lines (100 loc) · 6.33 KB
Raw

License

PortfolioForge

Create a portfolio, develop your online footprint.

💻 Github Repository: https://github.com/jwilferd10/PortfolioForge

💻 Live Standard Template Example: https://jwilferd10.github.io/PortfolioForge/

💻 Live Customized Example: https://jwilferd10.github.io/Jonathan-Wilferd-PortfolioForge/

📂 Table of Contents:

📷 Preview:

Coming Soon!

👋 Description:

🌐 Your Digital Showcase

In our ever-evolving world, the internet has become an integral part of our lives, profoundly impacting various aspects of our culture and society. Establishing a professional online presence is now more critical than ever, and PortfolioForge is here to assist in that endeavor. PortfolioForge is a versatile and user-friendly portfolio generator tailored to empower developers and professionals. It enables you to effortlessly showcase your skills, talents, and achievements, allowing you to make a meaningful digital impression.

🚀 Features:

  • Powered by Inquirer, users are guided through the portfolio creation process with multiple questions.
  • Tailor your portfolio to highlight your projects and showcase your unique strengths and experiences.
  • Further customize your portfolio by selecting a color theme
  • Generate a ready-to-use web profile.
  • Provides a solid foundation for future development and customization.
    • Includes a well-structured style.css for easy customization.
    • Access to FontAwesome for diverse and accessible image options.

🌐 Open

PortfolioForge was designed so that anyone can easily create a web profile. That's why this repository is open to the public, fostering exploration and creativity. Feel free to dive into the codebase, generate profiles, fork the project, and tailor it to your requirements. We're completely open-source.

💭 Developer Notes

  • I've updated Inquirer to use version 9.2.8, enhancing the user experience and ensuring compatibility with the latest features and improvements.
  • New Color Themes have been added to the project, allowing for a more customizeable experience

PortfolioForge was a fun, exciting, and educational project to work on. This was the project where I first learned and utilized concepts such as Node.js, NPM, and subsequently Inquirer. This project has allowed me to gain hands-on experience with modern development tools and practices, making it a valuable learning journey. The process of updating and maintaining this project reinforced my knowledge in software development, project management, and version control, providing what I believe is a solid foundation for future endeavors.

As of right now the project is only accessible if you download the repository. In the future, I'd like to create a more accessible version of PortfolioForge that can be used online. Allowing more people to try out and create their own portfolios.

🙏 Thank You!

So much for your interest in PortfolioForge. My intention is that it proves helpful to you and sparks the idea that you can create a unique online portfolio, whether or not you choose to use PortfolioForge. Thanks again and happy coding!

📖 User Story:

AS A DEVELOPER I WANT an application that generates a baseline portfolio page SO THAT I have a file I can modify

GIVEN a need for a Portfolio Generator

  • WHEN I launch the application
    • THEN I am introduced to the creation process
  • WHEN I select my desired content
    • THEN I am prompted to enter necessary details
  • WHEN I have finished my prompts
    • THEN the portfolio is created

💾 Resources Used:

  • Node.js
  • NPM (Node Package Manager)
  • Inquirer.js (v.^9.2.8)
  • FontAwesome (v.5.11.2)
  • HTML
  • CSS

💽 Getting Started:

PortfolioForge allows you to generate a professional portfolio page for showcasing your personal projects, skills, and achievements. It's a command-line tool that collects your information through prompts and then generates an HTML portfolio page based on your input.

Prerequisites

Before you begin, ensure that you have met the following requirements:

  • A Source-Code Editor
    • VSCode, etc
  • Node.js
    • PortfolioForge uses Node.js, make sure it's installed on your system. If not, you can download and install it from https://nodejs.org/en.

Installation

  1. Clone this repository to your local machine using the following command:

  • HTML:

     git clone https://github.com/jwilferd10/PortfolioForge.git

  • SSH:

      git clone [email protected]:jwilferd10/PortfolioForge.git

  1. Navigate to the project's root directory

  2. Install the project dependencies:

      npm install

Usage

To generate your portfolio, follow these steps:

  1. Open your terminal & Ensure you're on the project directory.
  2. Run the following command to start the application:
  node app.js
  1. You will then be prompted to enter various details, such as your name, GitHub username, skills, project information, and more. Answer each prompt accordingly.
  2. Once you've completed all the prompts, the application will generate an HTML portfolio based on your input
  3. The page will be located within the dist folder as index.html. You can open that html file to view your portfolio

Customization

With PortfolioForge, your choices heavily influence how base template will turn out.

Additionally you can customize the appearance and styling of your portfolio page by editing the style.css file within the dist folder. Feel free to modify the CSS to match your personal preference.

Troubleshooting

If you encounter any issues, please open an issue on this repository

License

This project is licensed under the MIT License.

📎 Contributors

  • jwilferd10 (UX/UI Adjustments, Updated Inquirer, Select Color Theme, New Portfolio Sections)
  • UCLA Coding Bootcamp (Base Setup)

📧 Contact Information: