https://github.com/ragingwind/next-init
CLI for Next.js apps scaffolding from whatever
https://github.com/ragingwind/next-init
Last synced: 4 months ago
JSON representation
CLI for Next.js apps scaffolding from whatever
- Host: GitHub
- URL: https://github.com/ragingwind/next-init
- Owner: ragingwind
- License: mit
- Created: 2017-09-21T11:20:17.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-16T08:43:57.000Z (over 8 years ago)
- Last Synced: 2025-10-20T00:51:48.074Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 180 KB
- Stars: 8
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
> CLI for Next.js apps scaffolding from whatever
## Install
```sh
$ npm install -g next-init
```
## Getting Started
```sh
# init with default tempalte
$ next-init ./my-next-app
# install dependencies
$ cd ./my-next-app
$ npm install
# start next app in dev mode. equivalent to use `npm run dev`
$ next-dev
# start the next app in production. equivalent to use `npm run build && npm start`
$ next-build && next-start
```
## More Usage
```sh
next-init --help
```
## Examples
```sh
# default template
$ next-init
$ next-init ./my-next-app
# with interactive mode to update template values
$ next-init -i
# default template with @latest stable version
$ next-init @latest
$ next-init @latest ./my-next-app
# default template with @canary version
$ next-init @canary
$ next-init @canary ./my-next-app
# community template on github, inspired from `vue init`
$ next-init username/username-next-app
$ next-init username/someone-next-app ./my-next-app
# official examples to current or target path
$ next-init next.js/examples/
$ next-init next.js/examples/ ./my-next-app
$ next-init next.js/examples/with-glamorous ./my-next-app
```
## Alias
next-init supports alias of next commands. those of registered global scope commands will execute next bin in current path after discoverying in local path of `node_modules`
```sh
# equivalent command of `next dev`
next-dev
# equivalent command of `next start`
next-start
# equivalent command of `next build`
next-build
```
## License
MIT © [Jimmy Moon](https://github.com/ragingwind)