diff options
Diffstat (limited to 'vid-webpack-master/README.md')
| -rw-r--r-- | vid-webpack-master/README.md | 149 |
1 files changed, 149 insertions, 0 deletions
diff --git a/vid-webpack-master/README.md b/vid-webpack-master/README.md new file mode 100644 index 000000000..5c37773bd --- /dev/null +++ b/vid-webpack-master/README.md @@ -0,0 +1,149 @@ +# angular-webpack + +[](https://david-dm.org/preboot/angular-webpack#info=dependencies) [](https://david-dm.org/preboot/angular-webpack#info=devDependencies) +[](https://gitter.im/preboot/angular-webpack?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +A complete, yet simple, starter for Angular v2+ using Webpack. + +This seed repo serves as an Angular starter for anyone looking to get up and running with Angular and TypeScript fast. Using [Webpack](http://webpack.github.io/) for building our files and assisting with boilerplate. We're also using Protractor for our end-to-end story and Karma for our unit tests. +* Best practices in file and application organization for [Angular](https://angular.io/). +* Ready to go build system using [Webpack](https://webpack.github.io/docs/) for working with [TypeScript](http://www.typescriptlang.org/). +* Testing Angular code with [Jasmine](http://jasmine.github.io/) and [Karma](http://karma-runner.github.io/). +* Coverage with [Istanbul](https://github.com/gotwarlost/istanbul) +* End-to-end Angular code using [Protractor](https://angular.github.io/protractor/). +* Stylesheets with [SASS](http://sass-lang.com/) (not required, it supports regular css too). +* Error reported with [TSLint](http://palantir.github.io/tslint/) and [Codelyzer](https://github.com/mgechev/codelyzer). +* Documentation with [TypeDoc](http://typedoc.org/). + +>Warning: Make sure you're using the latest version of Node.js and NPM + +### Quick start + +```bash +# clone our repo +$ git clone https://github.com/preboot/angular-webpack.git my-app + +# change directory to your app +$ cd vid-app + +# install the dependencies with npm +$ npm install + +# start the server +$ npm start +``` +go to [http://localhost:8181](http://localhost:8181) in your browser. + +# Table of Contents + +* [Getting Started](#getting-started) + * [Dependencies](#dependencies) + * [Installing](#installing) + * [Developing](#developing) + * [Testing](#testing) + * [Production](#production) + * [Documentation](#documentation) +* [Frequently asked questions](#faq) +* [TypeScript](#typescript) +* [License](#license) + +# Getting Started + +## Dependencies + +What you need to run this app: +* `node` and `npm` (Use [NVM](https://github.com/creationix/nvm)) +* Ensure you're running Node (`v6.x.x`+) and NPM (`3.x.x`+) + +## Installing + +* `fork` this repo +* `clone` your fork +* `npm install` to install all dependencies + +## Developing + +After you have installed all dependencies you can now start developing with: + +* `npm start` + +It will start a local server using `webpack-dev-server` which will watch, build (in-memory), and reload for you. The application can be checked at `http://localhost:8181`. + +As an alternative, you can work using Hot Module Replacement (HMR): + +* `npm run start:hmr` + +And you are all set! You can now modify your components on the fly without having to reload the entire page. + +## Testing + +#### 1. Unit Tests + +* single run: `npm test` +* live mode (TDD style): `npm run test-watch` + +#### 2. End-to-End Tests (aka. e2e, integration) + +* single run: + * in a tab, *if not already running!*: `npm start` + * in a new tab: `npm run webdriver-start` + * in another new tab: `npm run e2e` +* interactive mode: + * instead of the last command above, you can run: `npm run e2e-live` + * when debugging or first writing test suites, you may find it helpful to try out Protractor commands without starting up the entire test suite. You can do this with the element explorer. + * you can learn more about [Protractor Interactive Mode here](https://github.com/angular/protractor/blob/master/docs/debugging.md#testing-out-protractor-interactively) + +## Production + +To build your application, run: + +* `npm run build` + +You can now go to `/dist` and deploy that to your server! + +## Documentation + +You can generate api docs (using [TypeDoc](http://typedoc.org/)) for your code with the following: + +* `npm run docs` + +# FAQ + +#### Do I need to add script / link tags into index.html ? + +No, Webpack will add all the needed Javascript bundles as script tags and all the CSS files as link tags. The advantage is that you don't need to modify the index.html every time you build your solution to update the hashes. + +#### How to include external angular libraries ? + +It's simple, just install the lib via npm and import it in your code when you need it. Don't forget that you need to configure some external libs in the [bootstrap](https://github.com/preboot/angular-webpack/blob/master/src/main.ts) of your application. + +#### How to include external css files such as bootstrap.css ? + +Just install the lib and import the css files in [vendor.ts](https://github.com/preboot/angular-webpack/blob/master/src/vendor.ts). For example this is how to do it with bootstrap: + +```sh +npm install bootstrap@next --save +``` + +And in [vendor.ts](https://github.com/preboot/angular-webpack/blob/master/src/vendor.ts) add the following: + +```ts +import 'bootstrap/dist/css/bootstrap.css'; +``` + +# TypeScript + +> To take full advantage of TypeScript with autocomplete you would have to use an editor with the correct TypeScript plugins. + +## Use a TypeScript-aware editor + +We have good experience using these editors: + +* [Visual Studio Code](https://code.visualstudio.com/) +* [Webstorm 11+](https://www.jetbrains.com/webstorm/download/) +* [Atom](https://atom.io/) with [TypeScript plugin](https://atom.io/packages/atom-typescript) +* [Sublime Text](http://www.sublimetext.com/3) with [Typescript-Sublime-Plugin](https://github.com/Microsoft/Typescript-Sublime-plugin#installation) + +# License + +[MIT](/LICENSE) |