Skip to main content

Installation

Portfolio Generator is an officially supported way to create your own portfolio website in Next JS. It offers a modern build setup with no configuration.

  • You have to pass argument <project-direcotry> to run the package.
  • View all avaliable options here

Quick Start

npx portfolio-generator@latest my-portfolio
cd my-app
npm run dev
  • Then open http://localhost:3000/ to see your portfolio.
  • When you're ready to deploy to production, create a minified bundle with npm run build.
  • View all available npm scripts here
caution

If you've previously installed portfolio-generator globally via npm install -g portfolio-generator, we recommend you uninstall the package using npm uninstall -g portfolio-generator to ensure that npx always uses the latest version.

tip

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)

npx portfolio-generator my-portfolio --dummy

Creating an App

caution

You'll need to have Node >= 14 to build the portfolio. You can use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects.


To create a new app, you may choose one of the following methods:
npx portfolio-generator@latest my-portfolio
tip

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)