# create-ndcf-app

> A CLI tool to create a Next.js 14 boilerplate app with Docker configuration, ready to be pushed to SAP BTP Cloud Foundry.

Latest version **0.1.1** (published 2024-07-01) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install create-ndcf-app
pnpm add create-ndcf-app
yarn add create-ndcf-app
bun add create-ndcf-app
```

Provides the commands `ndcf-app`, `create-ndcf-app`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2024-07-01 |
| First published | 2024-06-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=16.0.0 |
| Dependencies | 8 |
| Unpacked size | 1.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Keywords | ndcf, next, sap, btp, cloud, foundry, docker, tailwind, ui, shadcn, cf, app-router, pages-router, cloud-foundry, shadcn/ui |

## Links

- npm: https://www.npmjs.com/package/create-ndcf-app
- Repository: https://github.com/Suman-JS/create-ndcf-app
- Homepage: https://github.com/Suman-JS/create-ndcf-app#readme
- Issues: https://github.com/Suman-JS/create-ndcf-app/issues
- npm.io page: https://npm.io/package/create-ndcf-app

## Dependencies (8)

- [ora](https://npm.io/package/ora.md) ^8.0.1
- [chalk](https://npm.io/package/chalk.md) ^5.3.0
- [eslint](https://npm.io/package/eslint.md) ^9.6.0
- [figlet](https://npm.io/package/figlet.md) ^1.7.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.1.1
- [inquirer](https://npm.io/package/inquirer.md) ^9.2.23
- [commander](https://npm.io/package/commander.md) ^12.1.0
- [gradient-string](https://npm.io/package/gradient-string.md) ^2.0.2

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads
- [@modern-js/plugin-swc](https://npm.io/package/@modern-js/plugin-swc.md) — 3.4K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2024-07-01
- 0.1.0 — 2024-06-29

## README

# create-ndcf-app

Create a Next.js 14 boilerplate app quickly and easily with our CLI tool, which includes Docker settings for easy containerization. This tool prepares a project for deployment to SAP BTP Cloud Foundry, including the'shadcn/ui' component library and 'tailwindcss' for optimized style. It supports JavaScript and TypeScript, making it suitable for a wide range of development needs. This full CLI solution simplifies the setup process and allows you to focus on building your application. Start your project swiftly and deploy confidently.

## Features

- Generates a Next.js 14 app with TypeScript/JavaScript
- Includes TailwindCSS configuration
- Sets up shadcn/ui components
- Optionally includes Docker configuration
- Prepared for deployment to SAP BTP Cloud Foundry

## Usage

Follow these steps to create a new Next.js 14 project:

```bash
npx create-ndcf-app@latest
```

## or

```bash
yarn create ndcf-app
```

## or

```bash
pnpm create ndcf-app@latest
```

## or

```bash
bunx create-ndcf-app@latest
```

## Interactive Mode

The CLI will guide you through a series of questions to set up your project. Answer the prompts to customize your project configuration.

> - What will your project be called?
> - Will you be using TypeScript or JavaScript?
>   - TypeScript
>   - JavaScript
> - Would you like to use App Router or Pages Router?
>   - App Router
>   - Pages Router
> - Would you like to use ESLint? (Y/n)
> - Would you like to use Prettier? (Y/n)
> - Would you like to use --turbo flag? (Y/n)
> - Would you like to use a 'src' directory? (y/N)
> - Do you want to include Docker configuration? (Y/n)
> - Initialize a new git repository? (Y/n)
> - Which Container Registry would you like to use?
>   - DockerHub
>   - GitHub Container Registry
> - What is your GitHub Container Registry username?
> - What is your DockerHub username?
> - Would you like us to run 'npm install' for you? (Y/n)

## Navigate to Your Project Directory

Once the project is generated, navigate to your new project directory:

```bash
cd <your-project-name>
```

Install Dependencies

Install the project dependencies:

```bash
npm install
```

or

```bash
yarn install
```

or

```bash
pnpm install
```

or

```bash
bun install
```

Start the Development Server

```bash
npm run dev
```

or

```bash
yarn dev
```

or

```bash
pnpm dev
```

or

```bash
bun dev
```

Deploy to Cloud Foundry

If you chose to include Docker configuration, it should generate a `Dockerfile` and `.dockerignore` file in the project directory. Now login accout to your Cloud Foundry account and run the following command to push the app to Cloud Foundry:

First make sure you have the Cloud Foundry CLI installed. You can download it from [click here](https://docs.cloudfoundry.org/cf-cli/install-go-cli.html).

Login to Cloud Foundry:

```bash
cf login
```

Run the following command to create a dockerimage and push it to the dockerhub/github container registry and push the manifest to Cloud Foundry:

```bash
npm run cf:push
```

or

```bash
yarn run cf:push
```

or

```bash
pnpm run cf:push
```

or

```bash
bun run cf:push
```

Once the app is deployed, you can access it at the URL provided by Cloud Foundry.

## Contributing

If you find a bug or have a feature request, please open an issue on GitHub.

## License

This project is licensed under the MIT License.

---
_Source: https://npm.io/package/create-ndcf-app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._