Angular2 Universal Starter Kit
#What we've got here
# clone the repo without git history git clone --depth 1 https://github.com/alexpods/angular2-universal-starter.git # change current directory to angular2-universal-starter cd angular2-universal-starter # install dependencies npm install # run the production server npm start
Go to http://localhost:3000 in your browser.
You may want to stop or restart the production server:
# stop the production server npm stop # restart the production server npm restart
# make sure that the production server is not running npm stop # run the development server with live reloading support npm run dev
The development server will watch for any changes, make rebuilds and reload a browser. All built code will be kept in
dist folder will not be generated (all means code for both client and server sides).
##Turning server side rendering and web workers on/off
You can optionally turn server side rendering or web workers suport on/off. You just need
// ... // Server side rendering. Set it to `false` to turn it of. exports.HAS_SS = 'NG2_SS' in process.env ? process.env.NG2_SS === 'true' : true; // For example: // exports.HAS_SS = false; // Web workers support. Set it to `false` to turn it of. exports.HAS_WW = 'NG2_WW' in process.env ? process.env.NG2_WW === 'true' : true; // For example: // exports.HAS_WW = 'NG2_WW' in process.env ? process.env.NG2_WW === 'true' : false; //...
Then you need to restart the server to apply the changes:
# for production server npm restart # for development server - stop its process and run it again npm run dev
# build the project npm run build # build the project and start watching for its changes npm run build:watch
# check the project (source files) npm run lint # check the project and start watching for its changes npm run lint:watch
If you're not agree with the default rules (
tslint.json), feel free to tell me about it.
#Testing The next command will run both unit and end-to-end tests.
For end-to-end tests you need to start Selenium Server first (see End-to-End Testing).
# run all tests (single run) npm test
# run unit tests (single run) npm run unit # run unit tests and start watch for changes npm run unit:watch # run unit tests for specified directory (path must be relative to root directory) # currently you can specify paths only for "src" directory npm run unit src/app # run unit tests for specified file and start watch for changes npm run unit:watch src/app/home.spec.ts
##End-to-End Testing For end-to-end tests you nedd to start Selenium Server (webdriver) first.
# start Selenium Server (webdriver) npm run webdriver:start # run end-to-end test (single run) npm run e2e
# remove "dist" and "logs" folders npm run clean # remove "dist" folder npm run clean:dist # remove "logs" folder npm run clean:logs
#License The MIT License (MIT)
Copyright (c) 2016 Aleksey Podskrebyshev
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.