Get Started

Installation

• undefined

undefined

# install globally
npm i -g @nutin/cli
		

undefined


Create A New Nutin App

• undefined

undefined

nutin-new
# or
create-nutin-app

# without global install
npx @nutin/cli

# argument: project-name (prompt if not provided)

# Help
-h --help

# Package manager
-pm --package-manager <manager> # npm, yarn, pnpm, bun

# Presets
--preset <minimal|standard|full|cicd>
	# minimal: external templates
	# standard: minimal + i18n & built-in SCSS classes
	# full: standard + deployment helpers & built-in testing toolkit
	# cicd: minimal + deployment helpers

# Features
--i18n # Use i18n & json-based content
--deploy-helper # Use Docker & deployment helpers
--testin-nutin # Use testin-nutin toolkit
--transition # Use animated view transitions. Note: May interfere with CSS `position: fixed`, `z-index`...
		

undefined


Scripts

• undefined

undefined

# Builder
npm run build  # build (dev)
npm run build:prod  # build (prod)

# Development Server
npm run serve:only  # serve without build (use existing build output)
npm run serve  # build and serve
npm run dev  # live reload / rebuild

# Generator (ELEMENT = component | view | service); ELEMENT-NAME --> kebab-case
npm run generate ELEMENT ELEMENT-NAME
npm run generate ELEMENT PATH/TO/ELEMENT-NAME

# Deployment helpers
npm run docker:build
npm run docker:prod

# testin-nutin
npm run test  # test without build (use existing build output)
npm run test:rebuild  # build and test
npm run test:watch  # watch tests

# Versioning
npm run patch
npm run minor
npm run major
		

undefined


Project Structure

• undefined

undefined

config/  -- only when using i18n
	languages.json
public/
src/
	app/
		components/
			my-component/
				locales/  -- only when using i18n
				my-component.component.ts
				my-component.component.html  -- only when using external templates
			index.ts  -- barrel file (exports)
		services/
			my-service/
					my-service.service.ts
			index.ts  -- barrel file (exports)
		views/
			home/
				locales/  -- only when using i18n
				home.view.ts
				home.view.html  -- only when using external templates
			index.ts  -- barrel file (exports)
	globals.d.ts
	main.ts
	routes.ts
	assets/
	core/  -- nutin's code
	libs/  -- nutin's libraries
	styles/
	index.html
testin-nutin/ -- only when using testin-nutin
tools/  -- builder, dev, generator, deployment
builder.config.js
package.json
testin-nutin.config.js  -- only when using testin-nutin
tsconfig.json
		

undefined