You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 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.
Warning: Make sure you're using the latest version of Node.js and NPM
Quick start
# clone our repo
$ git clone https://github.com/preboot/angular-webpack.git my-app
# change directory to your app
$ cd my-app
# install the dependencies with npm
$ npm install
# start the server
$ npm start
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 https://localhost:8080.
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 now go to /dist and deploy that to your server!
Documentation
You can generate api docs (using TypeDoc) 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 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. For example this is how to do it with bootstrap: