This is my new project which creates a new AngularJS module project using a seed project.
The project is hosted on GitHub and published on npm
It uses my AngularJS Module Seed Project
Install
$ npm install -g mams |
It is best to install it globally as you would be using it to create new projects and you want the command to be available anywhere.
Usage
Usage: mams [options] Options: -V, --version output the version number -p, --project <value> The name of the project -d, --desc [value] The description of the project -o, --output-file [value] The otuput file -g, --create-github-repo Creates a GitHub repository -t, --access-token <value> The GitHub access token -h, --help output usage information |
Examples
Basic Usage
This just creates a new project directory, clones the seeder project & updates the metadata of package.json, bower.json, build.conf.js.
mams -p mx-angular-notify -d "AngularJS module for showing toast notifications" |
You will get an output like:-
Maxotek Angular Module Seeder v 1.0.3 Created project directory: mx-angular-notify Seeder repository: https://github.com/maxotek/mx-angular-module-seed.git Seeder repository cloned at: mx-angular-notify Project: mx-angular-notify Description: AngularJS module for showing toast notifications Output File: mx-angular-notify.js Project URL: null HTTPS URL: null SSH URL: null mx-angular-notify/package.json updated mx-angular-notify/bower.json updated mx-angular-notify/build.conf.js updated Renamed project file to: mx-angular-notify/src/mx-angular-notify.js mx-angular-notify/src/mx-angular-notify.js updated Updated project name in: mx-angular-notify/src/mx-angular-notify.js |
Advanced Usage (Also creates GitHub Repository)
mams -p mx-angular-notify -d "AngularJS module for showing toast notifications" -g -t 72a8a3e2b8374bcb8acaf0d0f7f4a708 |
In addition to the stuff the Basic Usage does, this also creates a GitHub repository using your GitHub access token. Click here to know how to generate one.
Maxotek Angular Module Seeder v 1.0.5 Creating GitHub Repository Listing repositories Found: 31 repositories Created project directory: mx-angular-notify Seeder repository: https://github.com/maxotek/mx-angular-module-seed.git Seeder repository cloned at: mx-angular-notify Repository created at: https://github.com/maxotek/mx-angular-notify Project: mx-angular-notify Description: AngularJS module for showing toast notifications Output File: mx-angular-notify.js Project URL: https://github.com/maxotek/mx-angular-notify HTTPS URL: https://github.com/maxotek/mx-angular-notify.git SSH URL: git@github.com:maxotek/mx-angular-notify.git mx-angular-notify/package.json updated mx-angular-notify/bower.json updated mx-angular-notify/build.conf.js updated Renamed project file to: mx-angular-notify/src/mx-angular-notify.js mx-angular-notify/src/mx-angular-notify.js updated Updated project name in: mx-angular-notify/src/mx-angular-notify.js mx-angular-notify/.git/config updated |
Common errors
Error: 401 error making request GET https://api.github.com/user/repos: "Unauthorized"
Check that your access token passd after -t is correct.
The repository: mx-angular-notify already exists
The GitHub repository already exists under your account. If you want to start afresh, delete the repository and try again. Otherwise manually update the Project, Clone & SSH URLs