Clone the seed project from angular2 webpack starter.
this is a project I try to practise my Anuglar2 with the design found here https://www.behance.net/gallery/31860117/Honoured-singer
We use the component approach in our starter. This is the new standard for developing Angular apps and a great way to ensure maintainable code by encapsulation of our behavior logic. A component is basically a self contained app usually in a single file or a folder with each concern as a file: style, template, specs, e2e, and component class. Here's how it looks:
angular2-webpack-starter/
├──src/ * our source files that will be compiled to javascript
| ├──main.ts * our entry file for our browser environment
│ │
| ├──index.html * Index.html: where we generate our index page
│ │
| ├──polyfills.ts * our polyfills file
│ │
│ ├──app/ * WebApp: folder
│ │ ├──app.spec.ts * a simple test of components in app.ts
│ │ ├──app.e2e.ts * a simple end-to-end test for /
│ │ └──app.ts * App.ts: a simple version of our App component components
│ │
│ └──assets/ * static assets are served here
│ ├──icon/ * our list of icons from www.favicon-generator.org
│ ├──service-worker.js * ignore this. Web App service worker that's not complete yet
│ ├──robots.txt * for search engines to crawl your website
│ └──human.txt * for humans to know who the developers are
│
├──spec-bundle.js * ignore this magic that sets up our angular 2 testing environment
├──karma.config.js * karma config for our unit tests
├──protractor.config.js * protractor config for our end-to-end tests
│
├──tsconfig.json * config that webpack uses for typescript
├──typings.json * our typings manager
├──package.json * what npm uses to manage it's dependencies
│
├──webpack.config.js * our development webpack config
├──webpack.test.config.js * our testing webpack config
└──webpack.prod.config.js * our production webpack config
What you need to run this app:
node
andnpm
(brew install node
)- Ensure you're running the latest versions Node
v4.1.x
+ and NPM2.14.x
+
Once you have those, you should install these globals with npm install --global
:
webpack
(npm install --global webpack
)webpack-dev-server
(npm install --global webpack-dev-server
)karma
(npm install --global karma-cli
)protractor
(npm install --global protractor
)typings
(npm install --global typings
)typescript
(npm install --global typescript
)
fork
this repoclone
your forknpm install
to install all dependenciestypings install
to install necessary typingsnpm run server
to start the dev server in another tab
After you have installed all dependencies you can now run the app. Run npm run server
to 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://0.0.0.0:3000
(or if you prefer IPv6, if you're using express
server, then it's http://[::1]:3000/
).
# development
npm run server
# production
npm run build:prod
npm run server:prod
# development
npm run build:dev
# production
npm run build:prod
npm run watch
npm run test
npm run watch:test
# make sure you have your server running in another terminal
npm run e2e
npm run webdriver:update
npm run webdriver:start
npm run webdriver:start
# in another terminal
npm run e2e:live
You can include more examples as components but they must introduce a new concept such as Home
component (separate folders), and Todo (services). I'll accept pretty much everything so feel free to open a Pull-Request
To take full advantage of TypeScript with autocomplete you would have to install it globally and use an editor with the correct TypeScript plugins.
TypeScript 1.7.x includes everything you need. Make sure to upgrade, even if you installed TypeScript previously.
npm install --global typescript
We have good experience using these editors:
- Visual Studio Code
- Webstorm 10
- Atom with TypeScript plugin
- Sublime Text with Typescript-Sublime-Plugin
When you include a module that doesn't include Type Definitions inside of the module you need to include external Type Definitions with Typings
npm install --global typings
When including 3rd party modules you also need to include the type definition for the module if they don't provide one within the module. You can try to install it with typings
typings install node --save
If you can't find the type definition in the registry we can make an ambient definition in this file for now. For example
declare module "my-module" {
export function doesSomething(value: string): string;
}
If you're prototying and you will fix the types later you can also declare it as type any
declare var assert: any;
If you're importing a module that uses Node.js modules which are CommonJS you need to import as
import * as _ from 'lodash';
You can include your type definitions in this file until you create one for the typings registry see typings/registry
- What's the current browser support for Angular 2 Beta?
- Please view the updated list of browser support for Angular 2
- Why is my service, aka provider, is not injecting parameter correctly?
- Please use
@Injectable()
for your service for typescript to correctly attach the metadata (this is a TypeScript problem)
- Please use
- How do I run protractor with node 0.12.x?
- please check out this repo to use the old version of protractor #146
- Where do I write my tests?
- You can write your tests next to your component files. See
/src/app/home/home.spec.ts
- You can write your tests next to your component files. See
- How do I start the app when I get
EACCES
andEADDRINUSE
errors?- The
EADDRINUSE
error means the port3000
is currently being used andEACCES
is lack of permission for webpack to build files to./dist/
- The
- How to use
sass
for css? loaders: ['raw-loader','sass-loader']
and@Component({ styles: [ require('./filename.scss') ] })
see issue #136- How do I test a Service?
- See issue #130
- How do I add
vscode-chrome-debug
support? - The VS Code chrome debug extension support can be done via
launch.json
see issue #144 - How do I make the repo work in a virtual machine?
- You need to use
0.0.0.0
so revert these changes #205 - What are the naming conventions for Angular 2?
- please see issue #185 and PR 196
- How do I include bootstrap or jQuery?
- please see issue #215 and #214
- I'm getting an error about not finding my module that I installed?
- please see custom_typings.d.ts
- How do I async load a component?
- the component must have
.async.ts
and require using webpackloader: () => require('./about/about')('About')
Contact us anytime for anything about this repo or Angular 2
enjoy — AngularClass
Learn AngularJS, Angular 2, and Modern Web Development from the best. Looking for corporate Angular training, want to host us, or Angular consulting? [email protected]