Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andreasonny83/angular2-sonny-webpack

A Webpack2 starter kit for Angular2+
https://github.com/andreasonny83/angular2-sonny-webpack

angular angular-boilerplate angular2 angular4 progressive-web-app webapp

Last synced: 27 days ago
JSON representation

A Webpack2 starter kit for Angular2+

Awesome Lists containing this project

README

        

# Angular2 Sonny Webpack

![angular2-logo](http://i.imgur.com/50XbMNR.png)

A Webpack starter kit for you Angular2+ progressive web app

## Table of contents

* [Installation](#installation)
* [Usage](#usage)
* [Development](#development)
* [Progressive WebApp](#progressive-webapp)
* [Build](#build)
* [Test the distribution version](#test-the-distribution-version)
* [Contributing](#contributing)
* [Changelog](#changelog)
* [License](#license)

## Installation

Clone this repository

```sh
$ git clone https://github.com/andreasonny83/angular2-sonny-webpack.git
```

Change directory to our repo

```sh
$ cd angular2-sonny-webpack
```

Install the node dependencies

```bash
# You can either use npm with
$ npm install
# Or Yarn for a faster installation
$ yarn install
```

## Usage

### Development

```bash
$ npm start
```

To start the application and automatically recompile on file-changes.

### Progressive WebApp

This boilerplate will help you create a progressive web app in line with the [Google directives](https://developers.google.com/web/progressive-web-apps/).
The project contains an app `manifest.json` to add installable support.
Also, a service-worker will automatically been generated after the `build` process to grant offline support to your app.

### Build

To build a distribution version of your Angular2 app, run:

```bash
$ npm run build
```

This will generate a clean new `dist` folder containing your production-ready app.
A service worker will also being created in your distribution folder using the [sw-precache](https://github.com/GoogleChrome/sw-precache) node package.

### Test the distribution version

To serve your generated distribution version of the app, run:

```bash
$ npm run server:prod
```

This will open your distribution version of the app inside your browser. From here you may also being able to test the offline support.

## Contributing

1. Fork and clone it!
1. Create your feature branch: `git checkout -b my-new-feature`
1. Commit your changes: `git commit -am 'Add some feature'`
1. Push to the branch: `git push origin my-new-feature`
1. Submit a [Pull Request](https://github.com/andreasonny83/angular2-sonny-webpack/pull/new/master)

## Changelog

Changelog available [here](https://github.com/andreasonny83/angular2-sonny-webpack/blob/master/CHANGELOG.md)

## License

[MIT License](https://github.com/andreasonny83/angular2-sonny-webpack/blob/master/LICENSE) © Andrea SonnY