Skip to content

Commit ea6937c

Browse files
committed
update readme to preboot organization
1 parent 5624666 commit ea6937c

File tree

1 file changed

+64
-21
lines changed

1 file changed

+64
-21
lines changed

README.md

Lines changed: 64 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Angular 1.x Webpack 2 + Babel workflow
1+
# angular-webpack
22

3-
[![Dependency Status](https://david-dm.org/Foxandxss/angular-webpack-workflow/status.svg)](https://david-dm.org/Foxandxss/angular-webpack-workflow#info=dependencies) [![devDependency Status](https://david-dm.org/Foxandxss/angular-webpack-workflow/dev-status.svg)](https://david-dm.org/Foxandxss/angular-webpack-workflow#info=devDependencies)
3+
[![Dependency Status](https://david-dm.org/preboot/angular-webpack/status.svg)](https://david-dm.org/preboot/angular-webpack#info=dependencies) [![devDependency Status](https://david-dm.org/preboot/angular-webpack/dev-status.svg)](https://david-dm.org/preboot/angular-webpack#info=devDependencies)
4+
5+
A complete, yet simple, starter for Angular using webpack 2.
46

57
**NOTE: This workflow is now using Webpack 2 beta. There is a branch with the old workflow if you want to use it.**
68

79
This workflow serves as a starting point for building Angular 1.x applications using Webpack 2. Should be noted that apart from the pre-installed angular package, this workflow is pretty much generic.
810

9-
## Features
10-
1111
* Heavily commented webpack configuration with reasonable defaults.
1212
* ES6, and ES7 support with babel.
1313
* Source maps included in all builds.
@@ -17,33 +17,76 @@ This workflow serves as a starting point for building Angular 1.x applications u
1717
* Code coverage when tests are run.
1818
* No gulp and no grunt, just npm scripts.
1919

20-
## Installation
20+
>Warning: Make sure you're using the latest version of Node.js and NPM
21+
22+
[Is Angular 2 Ready Yet?](http://splintercode.github.io/is-angular-2-ready/)
23+
24+
### Quick start
25+
26+
> Clone/Download the repo then edit `app.js` inside [`/src/app/app.js`](/src/app/app.js)
2127
22-
To use it, just clone this repo and install the npm dependencies:
28+
```bash
29+
# clone our repo
30+
$ git clone https://github.com/preboot/angular-webpack.git my-app
2331

24-
```shell
25-
$ git clone https://github.com/Foxandxss/angular-webpack-workflow my_app
26-
$ cd my_app
32+
# change directory to your
33+
$ cd my-app
34+
35+
# install the dependencies with npm
2736
$ npm install
37+
38+
# start the server
39+
$ npm start
40+
```
41+
go to [http://localhost:8080](http://localhost:8080) in your browser.
42+
43+
# Table of Contents
44+
45+
* [Getting Started](#getting-started)
46+
* [Dependencies](#dependencies)
47+
* [Installing](#installing)
48+
* [Running the app](#running-the-app)
49+
* [Developing](#developing)
50+
* [Testing](#testing)
51+
* [License](#license)
52+
53+
# Getting Started
54+
55+
## Dependencies
56+
57+
What you need to run this app:
58+
* `node` and `npm` (Use [NVM](https://github.com/creationix/nvm))
59+
* Ensure you're running Node (`v4.1.x`+) and NPM (`2.14.x`+)
60+
61+
## Installing
62+
63+
* `fork` this repo
64+
* `clone` your fork
65+
* `npm install` to install all dependencies
66+
67+
## Running the app
68+
69+
After you have installed all dependencies you can now run the app with:
70+
```bash
71+
npm start
2872
```
2973

30-
## Scripts
74+
It will start a local server using `webpack-dev-server` which will watch, build (in-memory), and reload for you. The port will be displayed to you as `http://localhost:8080`.
3175

32-
All scripts are run with `npm run [script]`, for example: `npm run build`.
76+
## Developing
3377

34-
* `build` - generate a minified build to dist folder
35-
* `start` - start development server, try it by opening `http://localhost:8080/`
36-
* `test` - run all tests
37-
* `test-watch` - continuously run unit tests watching for changes
78+
### Build files
3879

39-
See what each script does by looking at the `scripts` section in [package.json](./package.json).
80+
* single run: `npm run build`
81+
* build files and watch: `npm run watch`
4082

41-
## Example and tutorial
83+
## Testing
4284

43-
To see how to structure an Angular 1.x application using this workflow, please check [this demo](https://github.com/Foxandxss/GermanWords-ng1-webpack).
85+
#### 1. Unit Tests
4486

45-
Also, there is an article in [angular-tips](http://angular-tips.com/blog/2015/06/using-angular-1-dot-x-with-es6-and-webpack/). The article is based on the Webpack 1 version, but almost everything is applicable here.
87+
* single run: `npm test`
88+
* live mode (TDD style): `npm run test-watch`
4689

47-
## License
90+
# License
4891

49-
The license of this workflow is MIT.
92+
[MIT](/LICENSE)

0 commit comments

Comments
 (0)