Your Portfolio, One Minute Away
Quickfolio is a fast and easy way to generate a personalized, professional portfolio website. Built with React, ShadCN, and TailwindCSS, Quickfolio lets you create a fully responsive, customizable portfolio in minutes. Perfect for developers, designers, and creatives who need a sleek online presence without the hassle.
- Fast Setup: Generate your portfolio site in minutes.
- Responsive Design: Optimized for mobile and desktop views.
- Customizable: Easily tweak the look and feel of your portfolio.
- Modern Stack: Built with React, ShadCN for UI components, and TailwindCSS for styling.
- Easy Deployment: Quickly deploy to platforms like Netlify, Vercel, or GitHub Pages.
Before you start, make sure you have the following installed:
- Node.js (v14 or higher)
- npm or yarn (npm comes with Node.js)
-
Clone the repository:
git clone https://github.com/FollowNaim/QuickFolio.git cd QuickFolio
-
Install dependencies:
npm install
To customize your portfolio, you can modify the config.json file (coming soon in a future update). In this file, you can add your personal details, such as name, bio, project links, and contact information, to populate your portfolio automatically.
To start the development server and view your portfolio locally, run:
npm start
Visit http://localhost:5173 in your browser to view your site in development mode.
Once you're happy with your portfolio, you can deploy it on platforms like Netlify or Vercel. Simply follow the instructions on their websites to connect your GitHub repository and deploy with ease.
- React: A JavaScript library for building user interfaces.
- ShadCN: UI components for modern design, providing a simple and customizable framework.
- TailwindCSS: A utility-first CSS framework for rapidly building custom designs.
- Vite: A fast and lightweight build tool that powers the development environment.
We welcome contributions to make Quickfolio even better. If you want to contribute, please follow these steps:
-
Fork the repository.
-
Create a new branch
git checkout -b feature/your-feature-name
- Make your changes and commit them
git commit -am 'Add new feature'
- Push to the branch
git push origin feature/your-feature-name
- Create a pull request
For any questions or feedback, feel free to reach out via email or open an issue on GitHub.