{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"The ngx directory","type":"basic","slug":"the-ngx-directory","excerpt":"","body":"## What?\n\nRepositories for boilerplates and components should be able to carry resources that are not part of the code that is scaffolded.\n\n## Why?\n\nThis allows developers to add resources (e.g. documentation) to a repository that should not be part of the scaffolded code.\n\n## How?\n\nEach GitHub repository must contain a directory called `ngx` in the root of the repository.\n\nThe `ngx` command line tool only scaffolds the resources located in the `ngx` directory when initializing a boilerplate or installing a component:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \".\\n├── LICENSE\\t\\t\\t\\t\\t\\t\\t\\t# NOT copied when scaffolded\\n├── README.md\\t\\t\\t\\t\\t\\t\\t# NOT copied when scaffolded\\n└── ngx\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t# Copied when scaffolded\\n    ├── README.md\\t\\t\\t\\t\\t# Copied when scaffolded\\n    ├── bin\\t\\t\\t\\t\\t\\t\\t\\t# Copied when scaffolded\\n    ├── config\\t\\t\\t\\t\\t\\t# Copied when scaffolded\\n    ├── index.js\\t\\t\\t\\t\\t# Copied when scaffolded\\n    ├── karma.conf.js\\t\\t\\t# Copied when scaffolded\\n    ├── lib\\t\\t\\t\\t\\t\\t\\t\\t# Copied when scaffolded\\n    ├── package.json\\t\\t\\t# Copied when scaffolded\\n    └── src\\t\\t\\t\\t\\t\\t\\t\\t# Copied when scaffolded\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n## Examples\n\n- [View the source code of the official boilerplates](https://github.com/ngx-boilerplates)\n- [View the source code of the official components](https://github.com/ngx-components)","updates":[],"order":999,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"558ba548cf331f23002046d1","createdAt":"2015-06-25T06:52:56.852Z","githubsync":"","project":"5511b00d316c512300151ccf","category":{"sync":{"isSync":false,"url":""},"pages":["558ba548cf331f23002046d1"],"title":"Principles","slug":"principles","order":9999,"from_sync":false,"reference":false,"_id":"558ba534cf331f23002046cf","version":"5511b00d316c512300151cd2","__v":1,"createdAt":"2015-06-25T06:52:36.294Z","project":"5511b00d316c512300151ccf"},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5511b00e316c512300151cd3","55462d123dca710d0046471b","55462d1e35b2240d008389f1","55462ee63dca710d0046471c","5586aedcd23ef40d00de6e95","5586aef0f8942c0d00293dd3","5586bc28867b5e0d0006c4bc","5586bce4f8942c0d00293ddf","5586c209f8942c0d00293def","5587d09eeb5f2421003f9781","558ba534cf331f23002046cf"],"_id":"5511b00d316c512300151cd2","project":"5511b00d316c512300151ccf","releaseDate":"2015-03-24T18:42:21.658Z","__v":11,"createdAt":"2015-03-24T18:42:21.658Z"},"__v":10,"user":"5511afda316c512300151cce"}
## 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: [block:code] { "codes": [ { "code": ".\n├── LICENSE\t\t\t\t\t\t\t\t# NOT copied when scaffolded\n├── README.md\t\t\t\t\t\t\t# NOT copied when scaffolded\n└── ngx\t\t\t\t\t\t\t\t\t\t# Copied when scaffolded\n ├── README.md\t\t\t\t\t# Copied when scaffolded\n ├── bin\t\t\t\t\t\t\t\t# Copied when scaffolded\n ├── config\t\t\t\t\t\t# Copied when scaffolded\n ├── index.js\t\t\t\t\t# Copied when scaffolded\n ├── karma.conf.js\t\t\t# Copied when scaffolded\n ├── lib\t\t\t\t\t\t\t\t# Copied when scaffolded\n ├── package.json\t\t\t# Copied when scaffolded\n └── src\t\t\t\t\t\t\t\t# Copied when scaffolded", "language": "shell" } ] } [/block] ## Examples - [View the source code of the official boilerplates](https://github.com/ngx-boilerplates) - [View the source code of the official components](https://github.com/ngx-components)