README.md

May 19, 2020 ยท View on GitHub

โšก๏ธ v6

The 6th iteration of my personal site built with Next.js and hosted with Netlify.

Netlify Build

https://v6.netlify.app

๐Ÿ™‹โ€โ™‚๏ธ Made by @abhijithvijayan

Donate: PayPal, Patreon

Buy Me a Coffee


demo

๐Ÿš€ Quick Start

  • yarn install to install dependencies.
  • yarn run dev to start the development server.
  • yarn run build build the files for production.
  • yarn run export to use Next.js static exports.
  • yarn run serve runs build and export commands at once.

๐Ÿšจ Using the template with CLI

Feel free to use this template to build your own portfolio site and deploy as static site to anywhere.

Use the @abhijithvijayan/portfolio CLI to generate template for your use.

If you do use the template, please just give me proper credit by linking back to my website, https://abhijithvijayan.in

๐ŸŒŸ Updating metadata

Copy sample.js to index.js in the config/ directory and update config/index.js with your custom information

๐ŸŒŸ Adding static contents

Copy contents (images, documents, etc...) to public/ directory

Use https://app-manifest.firebaseapp.com/ to generate Web Manifest

๐ŸŒŸ Adding other site-data

Copy sample.md to index.md in the markdown/SECTION_NAME directory and update accordingly. See how I did mine

๐ŸŒŸ PWA Support

Add icons for PWA to public/icons/ and update manifest.json in public/ directory

๐Ÿ–ค Show your support

Give a โญ if this you find this project useful!

๐Ÿ—ž Licence

Code released under the MIT License.

๐Ÿ‘ฉ๐Ÿพโ€๐Ÿ”ฌ Credits

Design inspired from Brittany Chiang