We would love for you to contribute to ng-wiz and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:
- Code of Conduct
- Question or Problem?
- How to develop ng-wiz
- Running unit tests
- Running end-to-end tests
Help us keep ng-wiz open and inclusive. Please read and follow our Code of Conduct.
You can open a GitHub issues for bug reports, feature requests, and missing documentation.
In order to run ng-wiz in development mode, clone the repository locally with
git clone https://github.com/ZimGil/ngWiz.git
go into the newly created folder and install all dependencies
cd ng-wiz
npm install
This will also build the application and create an initial dist folder.
To see code changes, run build after you make your changes
to create the dist folder:
npm run build
after that, start ng-wiz again.
This will run ng-wiz in developer mode with
ng-wiz's folder as root
npm start
If you want to test ng-wiz as if it was installed globally, run
npm link
This will create a semantic link to the repo's folder. You can run ng-wiz in your command line
from anywhere. Any changes will take effect after a restart.
Run ng test to execute the unit tests via Karma.
Run ng e2e to execute the end-to-end tests via Protractor.