https://github.com/tinotech-co-za/cleannextboilerplatecli

A CLI for generating a clean Next.js boilerplate with various base configurations.
https://github.com/tinotech-co-za/cleannextboilerplatecli

boilerplate clean context eslint mongodb next nextjs sass typescript

Last synced: 11 months ago
JSON representation

A CLI for generating a clean Next.js boilerplate with various base configurations.

• Host: GitHub
• URL: https://github.com/tinotech-co-za/cleannextboilerplatecli
• Owner: tinotech-co-za
• License: mit
• Created: 2022-06-10T18:36:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-06T14:49:12.000Z (about 3 years ago)
• Last Synced: 2025-02-12T11:46:16.540Z (11 months ago)
• Topics: boilerplate, clean, context, eslint, mongodb, next, nextjs, sass, typescript
• Language: JavaScript
• Homepage:
• Size: 218 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

          
# Clean Next.js Boilerplate CLI

![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/TinoMuzambi/CleanNextBoilerplateCLI?style=for-the-badge)

![npm (scoped)](https://img.shields.io/npm/v/@tinotech/clean-next-boilerplate?style=for-the-badge)

![npm](https://img.shields.io/npm/dw/@tinotech/clean-next-boilerplate?style=for-the-badge)

[![wakatime](https://wakatime.com/badge/user/6ff8627f-cb7f-4d1c-a080-4336f0a82762/project/ddb2540e-a494-4185-a959-5230affa37bd.svg?style=for-the-badge)](https://wakatime.com/badge/user/6ff8627f-cb7f-4d1c-a080-4336f0a82762/project/ddb2540e-a494-4185-a959-5230affa37bd)

[![Node.js Package](https://github.com/TinoMuzambi/CleanNextBoilerplateCLI/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/TinoMuzambi/CleanNextBoilerplateCLI/actions/workflows/npm-publish.yml)

Generate a clean Next.js boilerplate with various base configurations. To get started, use the following command:

```bash

npx @tinotech/clean-next-boilerplate

```

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:

```bash

npx @tinotech/clean-next-boilerplate blog-app

```

## Options

`@tinotech/clean-next-boilerplate` comes with the following options:

- -V, --version output the version number

- -y, --yes answer yes to all the prompts

- -h, --help display help for command

## Configurations

1. **with-javascript**

   The default and cleanest boilerplate with no extra dependencies or features.

2. **with-javascript-mongodb**

   A JavaScript Next.js boilerplate with the setup for integration with MongoDB.

3. **with-javascript-sass**

   A JavaScript Next.js boilerplate with the setup for using Sass. It includes the newer `use` and `forward` syntax and has some base styles separated into components and abstracts directories which can be customised.

4. **with-javascript-sass-mongodb**

   A JavaScript Next.js boilerplate which is an amalgamation of the `with-javascript-mongodb` and `with-javascript-sass` configurations.

5. **with-typescript**

   The default Next.js boilerplate setup for using TypeScript instead of JavaScript.

6. **with-typescript-mongodb**

   A TypeScript Next.js boilerplate with the setup for integration with MongoDB.

7. **with-typescript-sass**

   A TypeScript Next.js boilerplate with the setup for using Sass. It includes the newer `use` and `forward` syntax and has some base styles separated into components and abstracts directories which can be customised.

8. **with-typescript-sass-mongodb**

   A TypeScript Next.js boilerplate which is an amalgamation of the `with-typescript-mongodb` and `with-typescript-sass` configurations.

9. **with-eslint**

   There are `with eslint` versions of all the boilerplates above. These configurations just have a stock eslint configuration obtained by running `npx next lint` and choosing the `strict` option.

10. **with-context**

    There are `with-context` versions of all the boilerplates above which have a stock Context API config.