Portify

A simple portfolio generator

View Demo · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Tech Stack
  • Features
• Getting Started
  • Prerequisites
  • Installation
  • Run Locally
• License

About the project

Welcome to the Portfolio repository! This project enables you to create a fully customizable portfolio website by simply configuring a JSON file. The generator automates the process, making your portfolio available online with minimal effort.

Tech stack

• React
• GitHub
• Tailwind CSS

Tech stack

• JSON-based Configuration: Define your portfolio content easily in a single JSON file.
• Dynamic Web Generation: Automatically generates a responsive portfolio website.
• Ease of Deployment: Your portfolio is deployed to the web seamlessly.
• Customizable Design: Tailor the appearance and structure to suit your needs.

Getting Started

1. Create a GitHub repository.

2. Inside the repository, create a file named portify.config.json.

3. Add your portfolio configuration in portify.config.json. Here's an example:

{
  "name": "Peter",
  "lastname": "Parker",
  "roles": ["UX designer", "UI senior"],
  "description": "Lorem ipsum description",
  "mail": "example@example.com",
  "avaible-for-works": true,
  "contacts": [
    {
      "label": "GitHub",
      "href": "example.com"
    },
    {
      "label": "Mail",
      "href": "mailto:example@example.com"
    }
  ],
  "works-history": [
    {
      "position": "UX/UI designer senior",
      "period": ["2023", "now"],
      "company": "GitHub"
    },
    {
      "position": "UX/UI designer senior",
      "period": ["2022", "2023"],
      "company": "Apple"
    },
    {
      "position": "UX/UI designer junior",
      "period": ["2020", "2022"],
      "company": "Google"
    }
  ]
}

4. Save and commit the file to your repository.

5. Visit the following URL to view your portfolio:

https://pietropeerani.github.io/portify/#/<profile-name>/<repository-name>

Prerequisites

• Node.js
• GitHub account.

Installation

1. Clone the repository:

git clone https://github.com/pietropeerani/portify.git
cd portify

2. Install the dependencies:

npm i

Run locally

npm run dev

npm run dev -- --host# host development server on local network

License

Distributed under the MIT License. See LICENSE for more information.

Contact

• Project Link

(back to top)