Guides

The ngx directory

Suggest Edits

What?

Repositories for boilerplates and components should be able to carry resources that are not part of the code that is scaffolded.

Why?

This allows developers to add resources (e.g. documentation) to a repository that should not be part of the scaffolded code.

How?

Each GitHub repository must contain a directory called ngx in the root of the repository.

The ngx command line tool only scaffolds the resources located in the ngx directory when initializing a boilerplate or installing a component:

.
├── LICENSE								# NOT copied when scaffolded
├── README.md							# NOT copied when scaffolded
└── ngx										# Copied when scaffolded
    ├── README.md					# Copied when scaffolded
    ├── bin								# Copied when scaffolded
    ├── config						# Copied when scaffolded
    ├── index.js					# Copied when scaffolded
    ├── karma.conf.js			# Copied when scaffolded
    ├── lib								# Copied when scaffolded
    ├── package.json			# Copied when scaffolded
    └── src								# Copied when scaffolded

Examples

Updated less than a minute ago