0.1.3 • Published 2 years ago
lilpkg v0.1.3
Lil Pkg
The easiest way to get started with Next.js is by using lilpkg
. This CLI tool enables you to
quickly start building a new project, with everything set up for you. You can create a new app using
the default Next.js template, or by using one of the
official Next.js examples. To get started,
use the following command:
npx lilpkg
Or, for a TypeScript project:
npx lilpkg --typescript
To create a new app in a specific folder, you can send a name as an argument. For example, the
following command will create a new Next.js app called blog-app
in a folder with the same name:
npx lilpkg blog-app
Options
lilpkg
comes with the following options:
- --ts, --typescript - Initialize as a TypeScript project.
- -t, --template name|github-url - A template to bootstrap the project with. You can use an template name from the Lil Pkg repo or a GitHub URL. The URL can use any branch and/or subdirectory.
- --template-path <path-to-template> - In a rare case, your GitHub URL might contain a
branch name with a slash (e.g. bug/fix-1) and the path to the template (e.g. foo/bar). In this
case, you must specify the path to the template separately:
--template-path foo/bar
- --use-npm - Explicitly tell the CLI to bootstrap the app using npm. To bootstrap using yarn we
recommend to run
yarn lilpkg
- --use-pnpm - Explicitly tell the CLI to bootstrap the app using pnpm. To bootstrap using yarn
we recommend running
yarn lilpkg
Why use Lil Pkg?
lilpkg
allows you to create a new Next.js app within seconds. It is officially maintained by the
creators of lilpkg, and includes a number of benefits:
- Interactive Experience: Running
npx lilpkg
(with no arguments) launches an interactive experience that guides you through setting up a project. - Zero Dependencies: Initializing a project is as quick as one second. Lil Pkg has zero dependencies.
- Offline Support: Create Next App will automatically detect if you're offline and bootstrap your project using your local package cache.
- Support for Examples: Lil Pkg can bootstrap your project using an template from the Lil Pkg
templates collection (e.g.
npx lilpkg --template react
). - Tested: The package is part of the lilpkg monorepo and tested using the same integration test suite as Lil Pkg itself, ensuring it works as expected with every release.