Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tgorka/cliberry-ng6
Cliberry and Schematics collection for generation angular project with support and configuration for useful framework and tools
https://github.com/tgorka/cliberry-ng6
angular angular6 appsync aws cliberry codebuild es7 graphql javascript schematics serverless typescript yarn
Last synced: 26 days ago
JSON representation
Cliberry and Schematics collection for generation angular project with support and configuration for useful framework and tools
- Host: GitHub
- URL: https://github.com/tgorka/cliberry-ng6
- Owner: tgorka
- License: mit
- Created: 2018-09-11T09:31:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-12T16:09:33.000Z (over 6 years ago)
- Last Synced: 2024-11-15T09:50:08.923Z (3 months ago)
- Topics: angular, angular6, appsync, aws, cliberry, codebuild, es7, graphql, javascript, schematics, serverless, typescript, yarn
- Language: TypeScript
- Size: 120 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# cliberry-ng6
[](https://www.npmjs.com/package/cliberry-ng6)
[](http://opensource.org/licenses/MIT)
[](https://github.com/tgorka/cliberry-ng6)
[](https://www.npmjs.com/package/cliberry-ng6)
[](https://www.npmjs.com/package/cliberry-ng6)
[](https://david-dm.org/tgorka/cliberry-ng6)
[](https://travis-ci.org/tgorka/cliberry-ng6)
[](https://coveralls.io/r/tgorka/cliberry-ng6)
Cliberry/Schematics/angular cli collection for generation angular project with support and configuration for useful framework and tools.
This repository is a basic Schematic/Cliberry implementation that serves as a starting point to create and publish Schematics to NPM.
## Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [API](#api)
* [Testing](#testing)
* [Unit Testing](#unit-testing)
* [Publishing](#publishing)
### Installation
For using the cli you need to install the npm package first:
```bash
npm install g cliberry
```
or
```bash
yarn g cliberry
```
and then using cli like an [@angular/cli](https://cli.angular.io/).
The default schematics will be set to local templates if needed. They can be override
by adding additional `--collection` parameter.
There is no need to install `@angular/cli` it is included inside `cliberry` tool.
Have fun with using `cliberry` ;).
### Usage
#### cliberry
For using the project simply call
```bash
cliberry ng6 --force new NAME-OF-THE-PROJECT 'DESCRIPTION OF THE PROJECT'
```
`--force` is not needed for an empty folder
or to generate part of the project
```bash
cliberry ng6 g NAME-OF-THE-ACTION
```
`ng6` can not be needed if it's the default target of ng cli
(can be changed).
#### @angular/cli
[Angular CLI](https://github.com/angular/angular-cli)
```bash
ng c cliberry-ng6 new NAME-OF-THE-PROJECT 'DESCRIPTION OF THE PROJECT'
```
```bash
ng c cliberry-ng6 g NAME-OF-THE-ACTION
```
### API
##### cliberry new
Create new cliberry/schematics collection with:
* schematics
* debug framework
* yarn
* yarn lock file
* tests (jasmine, protractor - defaults)
* lint
* IDEA config
* editorconfig
* gitignore
* README
### Testing
To test locally, install `@angular-devkit/schematics-cli` globally and use the `schematics` command line tool. That tool acts the same as the `generate` command of the Angular CLI, but also has a debug mode.
Check the documentation with
```bash
schematics --help
```
### Unit Testing
`yarn test` or `npm run test` will run the unit tests, using Jasmine as a runner and test framework.
### Publishing
To publish, simply do:
```bash
yarn build
yarn publish
```
```bash
npm run build
npm publish
```
That's it!