README.md

Next.js Boilerplate

My personal template for Next.js projects.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Development
   • Deployment
3. License
4. Contact
5. Acknowledgements

About The Project

I usually use this boilerplate for any new Next.js project I made. This is tailor made to be deployed via Netlify.

Built With

• Next.js
• React
• SCSS
• Netlify

Getting Started

Here is a guide if you want to clone this template and modify it for yourself, all the way to deployment.

Prerequisites

• yarn
• git

Installation

1. Clone the repo

   git clone https://github.com/AjayLiu/ajayliu.com.git

2. Install packages

   yarn

Development

To run the development server

yarn dev

Then head over to localhost:3000

Deployment

1. Publish the site on Netlify using continuous git integration. 🎉

License

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

Contact

Ajay Liu - contact@ajayliu.com

Project Link: https://github.com/AjayLiu/next-js-boilerplate

Acknowledgements

• cassidoo/next-netlify-starter