tailor_next_generator

Tailor Next.js application generator with Styled-components & i18n translation module


Keywords
next, framework, web, tailor, styled-components, next.js, i18n, next-i18next, next-typescript
License
MIT
Install
npm install tailor_next_generator@4.0.1

Documentation

Tailor Next.js application generator with Styled-components & i18n translation module & Typescript.

Logo

Introduction

tailor_next_generator is Tailor's NPM package that allows us to quickly create next.js projects with the basic configuration.

Installation

Install tailor_next_generator as a global NPM package, so you can run it from anywhere in your computer:

$ npm install -g tailor_next_generator

Or use npx:

$ npx tailor_next_generator new-project/

Quick Start

The quickest way to get started with next.js is to utilize the executable tailorgenerate(1) to generate an application as shown below:

Create the app:

$ tailorgenerate new-project/
$ cd new-project/

This will generate the following directory structure:

new-project/
β”œβ”€β”€ .babelrc
β”œβ”€β”€ next.config.js
β”œβ”€β”€ package.json
β”œβ”€β”€ content
β”œβ”€β”€ components
β”‚   └── Meta.js
β”œβ”€β”€ static
β”‚    β”œβ”€β”€ fonts
β”‚    β”œβ”€β”€ svg
β”‚    └── img
β”œβ”€β”€ pages
β”‚    β”œβ”€β”€ index.js
β”œβ”€β”€ styles
β”‚   β”œβ”€β”€ fontsStyles
β”‚   β”œβ”€β”€ pagesStyles
β”œβ”€β”€ .env
β”œβ”€β”€ .gitignore

Install all dependencies described in package.json:

$ npm i

Start your next.js app:

$ npm run dev

Command Line Options

This generator can also be further configured with the following command line flags.

-h, --help           output usage information
    --git            initialise a Git project
    --i18n           i18n translation module configuration
    --type           typescript basic configuration 

License

MIT