Requirements

• Node.js and yarn

Getting started

Run the following command on your local environment:

git clone --depth=1 https://github.com/radudotat/portfolio.git my-portfolio
cd my-portfolio
yarn install

Then, you can run locally in development mode with live reload:

yarn dev

Open http://localhost:3000 with your favorite browser to see your project. For your information, Next JS need to take some time to compile the project for your first time.

.
├── README.md            # README file
├── next.config.js       # Next JS configuration
├── public               # Public folder
│   └── assets
│       └── images       # Image used by default template
├── src
│   ├── background       # Atomic background component
│   ├── button           # Atomic button component
│   ├── cta              # Atomic cta component
│   ├── feature          # Atomic feature component
│   ├── footer           # Atomic footer component
│   ├── hero             # Atomic hero component
│   ├── layout           # Atomic layout component
│   ├── navigation       # Atomic navigation component
│   ├── pages            # Next JS pages
│   ├── styles           # PostCSS style folder with Tailwind
│   ├── templates        # Default template
│   └── utils            # Utility folder
├── tailwind.config.js   # Tailwind CSS configuration
└── tsconfig.json        # TypeScript configuration

Customization

You can easily configure the theme. Please change the following file:

• public/apple-touch-icon.png, public/favicon.ico, public/favicon-16x16.png and public/favicon-32x32.png: your favicon, you can generate from https://favicon.io/favicon-converter/
• src/styles/global.css: your CSS file using Tailwind CSS
• utils/AppConfig.ts: configuration file
• src/pages/index.tsx: the index page of the theme that uses the Base component
• src/template/Base.tsx: the Base component using component blocks
• src/templates/*: the list of component blocks
• src/*: other folders in src are the atomic components used by components blocks

Here is the layer:

• the entry point: index.tsx in src/pages
• the Base template: Base.tsx in src/templates
• use component blocks from src/templates/*
• use atomic components from src/*

Deploy to production

You can see the results locally in production mode with:

$ yarn build
$ yarn start

The generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS.

You can create an optimized production build with:

yarn build-prod

Now, your theme is ready to be deployed. All generated files are located at out folder, which you can deploy with any hosting service.

Deploy to Netlify

Clone this repository on own GitHub account and deploy to Netlify:

Deploy to Vercel

Deploy this Next JS Boilerplate on Vercel in one click:

VSCode information (optional)

If you are VSCode users, you can have a better integration with VSCode by installing the suggested extension in .vscode/extension.json. The starter code comes up with Settings for a seamless integration with VSCode. The Debug configuration is also provided for frontend and backend debugging experience.

Pro tips: if you need a project wide type checking with TypeScript, you can run a build with Cmd + Shift + B on Mac.

Contributions

Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug.

License

Licensed under the GNU Affero General Public License v3.0 or later, Copyright © 2022 radudotat

See LICENSE for more information.