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

:sparkles: :canned_food: A simple boilerplate to work with Typescript, React, NextJs, and Styled Components.
https://github.com/georgekaran/next-boilerplate

eslint jest nextjs react storybook styled-components testing-library typescript

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/georgekaran/next-boilerplate
• Owner: georgekaran
• Created: 2020-09-04T01:39:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-14T01:34:36.000Z (about 1 year ago)
• Last Synced: 2024-01-14T08:59:19.623Z (about 1 year ago)
• Topics: eslint, jest, nextjs, react, storybook, styled-components, testing-library, typescript
• Language: TypeScript
• Homepage:
• Size: 7.4 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  


 


![ci](https://github.com/georgekaran/next-boilerplate/workflows/ci/badge.svg)

# 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](https://nextjs.org/docs) - "The React Framework

for Production".

* [Styled-Components](https://styled-components.com/) - "Visual primitives for the component age".