Angular Starter Kit
A better way to start your new Angular app
- SASS support including sourceMaps
- Minimal CSS styling of the view
- Gulp watch, build and local server tasks
- Minified CSS and JS build files
- Unit tests
- E2E tests covered by Protractor
- Istanbul code coverage
We assume you've already installed NodeJS, Gulp and Bower on your machine, if not, please follow the installation documentation from the official websites.
The easiest way to start your Angular project using Angular Starter Kit is Downloading the latest release of this project or simply cloning this repository with:
git clone https://github.com/andreasonny83/angular-starter-kit.git
Once done with the previous step, open your terminal to your angular-starter-kit folder, then install all the dependencies with:
This will create both a
bower_components folder inside
your local directory
Run the Application
There is already a preconfigured web server for this application. The simplest way to start this server is:
Now browse to the app url available at http://localhost:8000 to see your application running.
This task will also watch for any file change to your project's files and update the browser with the new changes using BrowserSync and Gulp.
Build a production version
npm run build
This will perform the following tasks:
- clean the
- compile SASS files, minify and uncss the compiled css
- copy and optimize images
- minify and copy all HTML files into $templateCache
- build index.html
- minify and copy all JS files
- copy fonts, if any
Serve the distribution folder
npm run serve:dist
This will compile your project in distribution mode and will trigger a
web server to listen to your generated
Open a browser and navigating to http://localhost:8000 to see the rendered application.
This will run all the unit tests present in your project folder using Karma.
The task will remain idle in your terminal waiting for file changes to run the tests again. This task is really useful during the development mode in order to avoid running manually your tests every time.
However, if you want just to run the test once and build a report displaying the unit test coverage, use the following task:
npm run test-single-run
Either way, all the reports will be stored inside a generated
coverage for the unit test coverage using Istanbul
End to end testing
The Angular Starter Kit app comes with end-to-end tests written in Jasmine. These tests are run with the Protractor End-to-End test runner.
Your web server needs to be serving up the application, so that Protractor can interact with it.
In order to start running your end-to-end tests, first start your web server with:
Now you can run the end-to-end tests, from another terminal instance,
using the supplied
npm run protractor
We really appreciate your collaborations and feedbacks!
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Changelog available here