Skip to content

Latest commit

 

History

History
177 lines (116 loc) · 5.67 KB

README.md

File metadata and controls

177 lines (116 loc) · 5.67 KB
Raw

Frontend Cordova

A complete, yet simple, starter for Angular 2 using Webpack.

This seed repo serves as an Angular 2 starter for anyone looking to get up and running with Angular 2 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.

Warning: Make sure you're using the latest version of Node.js and NPM

Quick start

Clone/Download the repo

# clone our repo
git clone https://github.com/CovalentLabs/project-w-app.git project-w-app

# change directory to the app
cd project-w-app

# install the dependencies with npm
npm install

# start the server with hot module reloading, or
npm run start:hmr

# start the server
npm start

go to http://localhost:8080 in your browser.

Deploy to device

Set up your computer with cordova and the JDK and Android SDK for deploying to Android. https://cordova.apache.org/docs/en/latest/guide/platforms/android/

# change directory to the app
cd project-w-app

# Must have this directory available in order to use cordova!
mkdir www

# add cordova platform android or ios
cordova platform add android

# build and deploy files with cordova, or
npm run deploy

# if you'd like faster deployment, we can skip optimization plugins using:
set "ENV=skipOpti" && npm run deploy
# or on unix:
ENV=skipOpti npm run deploy

# build files to ./www, then
npm run build

# ensure adb is running with devices connected
adb devices

# deploy to cordova either emulator or connected device
# if this command fails, try deleting the platforms directory and re-initializing the android platform
cordova run android

The following was included information from the boilerplate starter that this is based off of.

Table of Contents

Getting Started

Dependencies

What you need to run this app:

  • node and npm (Use NVM)
  • Ensure you're running Node (v6.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: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 learn more about Protractor Interactive Mode here

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) 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 2 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:

npm install bootstrap@next --save

And in vendor.ts add the following:

import 'bootstrap/dist/css/bootstrap.css';

License

(c) CovalentLabs