Next Boilerplate

A simple boilerplate to work with Typescript, React, NextJs and Styled Components.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

1. NPM or YARN

Installing

A step by step series of examples that tell you how to get a development env running

Clone the repo or "Use this template".

git clone https://github.com/georgekaran/next-boilerplate.git

Install the dependencies and run the app.

npm i

Available commands

Command	Description
dev	Start the application on development mode
build	Build the application
start	Start the application on production mode
lint	Lint the 'src' folder
test	Run all tests
test:staged	Run only new/modified tests
test:ci	Run tests and generate coverage report
test:watch	Run tests on watch mode
generate	Generate a new Component folder that includes styles, stories, test, and the component itself (See Main Component for an example)
storybook	Run Storybook on development mode
build-storybook	Build Storybook for production

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Next.JS - "The React Framework for Production".
• Styled-Components - "Visual primitives for the component age".