Starter project for Angular apps on the Availity platform.
- Requirements
- Features
- Getting Started
- Git
- Releasing
- Upgrading
- Troubleshooting
- Gulp
- NPM
- Best Practices
- Authors
- License
- node.js -
brew install node
(mac) - node-gyp - is a cross-platform command-line tool for compiling native add-on modules for Node.js. Please review your system requirements for Node to function properly.
- git -
brew install git
(mac) - gulp -
npm install -g gulp
- bower -
npm install -g bower
The Toolkit combines several projects that simplify developing web applications on Availity platform. These projects include:
- availity-angular - Client side web framework using Angular 1.2.28
- availity-ekko - Mock server for REST API simulation
- availity-uikit - HTML, CSS, and JS framework powered by Boostrap 3'ish
- availity-workflow - Upgradeable task and workflow modules that leverage:
- Fontello Fonts
git clone https://github.com/Availity/availity-toolkit {{your-project-name}}
cd {{your-project-name}}
npm install availity-workflow --save-dev
bower install availity-uikit availity-angular --save
npm install
- install module dependencies- run the CLI for project initialization by updating the
package.json
,bower.json
andavaility.json
meta info.- Windows:
node_modules\.bin\av init
- Mac:
./node_modules/.bin/av init
- Windows:
gulp
- starts the development server on
http://localhost:3000
- starts the development server on
Before pushing to Git repository:
- cd into
{{your-project-name}}
- delete the
.git
folder else you will containavaility-toolkit
history inside your project git init
git remote add origin ssh://{{your-git-url}}.git
git push
to your Git repo
npm run production
- run interactive cli
- minifies bundles
- cache bust bundles
- tags bundle in git
- bundles are stored in
./dist
folder
npm run staging
- run interactive cli
- cache bust bundles
- tags bundle in git
- bundles are stored in
./dist
folder
npm run integration
- run interactive cli
- cache bust bundles
- bundles are stored in
./build
folder
Always check the release logs for changes
- https://github.com/Availity/availity-workflow/releases
- https://github.com/Availity/availity-uikit/releases
- https://github.com/Availity/availity-angular/releases
Upgrading Availity bower modules
bower install availity-uikit availity-angular --save
Upgrading the Toolkit workflow
npm install availity-workflow --save-dev
- Git protocol blocked by firewall
git config --global url."https://".insteadOf git://
- Windows installation issues
- Please review your node-gyp system requirements for Node to function properly.
EADDRNOTAVAIL
orERR_CONNECTION_CLOSED
- Change bind address from
0.0.0.0
to127.0.0.1
orlocalhost
for your web server configuration
- Change bind address from
A gulpfile.js
is included your project and has been seeded with the following tasks:
gulp
- starts the development server onhttp://localhost:3000
gulp test
- executes your spec files using the Karma test runner and Phantom.jsgulp test:server
- equivalent to thegulp test
command but the Karma server continuously runs so that unit tests can be debugged.gulp lint
- checks for stylistic and programming errors using ESLint. Two .eslintrc/.eslintrc files are included in your project using the Availity Shared ESLint standards . The.eslintrc
file in the projec/app folder is configured for web development and ES3 support.
npm start
- starts the development server onhttp://localhost:3000
npm run tests
- executes your spec files using the Karma test runner and Phantom.jsnpm run production
- see releasingnpm run staging
- see releasingnpm run integration
- see releasingnpm run lint
- lint browser and node javascript files
/node_modules/.bin/av --help
We encourage you to organize your project using feature folders and dashes -
within file names for readability.
├── project
| ├── app/
| | ├── orders/
| | | ├── tests/
| | | | └──orders-directive-spec.js
| | | | └──orders-service-spec.js
| | | ├── templates/
| | | | └──orders-template.html
| | | ├── orders-directive.js
| | | ├── orders-controller.js
| | | └── orders-service.js
| | ├── users/
| | | ├── tests/
| | | | └──users-directive-spec.js
| | | | └──users-service-spec.js
| | | ├── templates/
| | | | └──users-template.html
| | │ ├── users-directive.js
| | │ ├── users-controller.js
| | | └── order-service.js
| | ├── index.js
| | ├── vendor.js
| | ├── module.js
| | ├── index.html
├── project
│ ├── app/
│ │ ├── controllers/
│ │ │ ├── homeController.js
│ │ │ └──loginController.js
│ │ ├── directives/
│ │ │ ├── usersDirective.js
│ │ │ └──ordersDirective.js
│ │ ├── services/
│ │ │ ├── userService.js
│ │ │ ├── orderService.js
│ │ │ └── loginService.js
Robert McGuinness
Robert Warner
Kasey Powers
Open source software components distributed or made available in the Availity Materials are licensed to Company under the terms of the applicable open source license agreements, which may be found in text files included in the Availity Materials.
Copyright (c) 2016 Availity, LLC. Code released under the the MIT license