This repo is all you need to develop web and mobile applications. We found the original repo was difficult and confusing when it came to adding support for more platforms. This structure will make it easier for you to reuse code and stay organized.
git Download gitnode and npm (Nodejs.org/download/current includes npm 3.10.3)ionic-cli and cordova
Make sure you have Node version >= 6.0 and NPM >= 3Clone this Repo, install frontend and backend applications with npm
Start backend api service in one window
Start frontend dev-server in separate window
# clone this repo
# --depth 1 removes all but one .git commit history
git clone --depth 1 https://github.com/strictd/angular2-ionic2-webpack.git
# change directory to this repo
cd angular2-ionic2-webpack
# install the frontend repo with npm
npm install
# change to backend repo
cd backend
# install the backend repo with npm
npm install
# start backend node service
node server.js
# if you're in China use cnpm
# https://github.com/cnpm/cnpmOpen second cmd window
# change directory to this repo
cd angular2-ionic2-webpack
# start the server
npm startgo to http://0.0.0.0:8080 or http://localhost:8080 in your browser
What you need to run this app:
- Ensure you're running Node (
v6.x.x+) and NPM (3.x.x+)- Check versions with
node -vandnpm -v- If you are behind a version try
npm update -g npmto update npm.- For node go to nodejs.org
- Ionic-CLI and Cordova, install using
npm install -g ionic cordova
git clone https://github.com/strictd/angular2-ionic2-webpack.git
cd angular2-ionic2-webpackUsing the command prompt enter:
npm installcd backend/
npm install
cd ..make sure you have nodejs.org installed
Install Cordova and Ionic-CLI
npm install -g cordova ionicInstall Ionic iOS Platform and Plugins
ionic state restorecp backend/sample.env backend/.env
vi backend/.envcopy backend/sample.env backend/.env
notepad backend/.envnode backend/server.js| Setting | Default |
|---|---|
| api server | localhost:3080 |
| debugging | On |
gulp configsSets compile settings for production
gulp configs --release
Sets Madame Server / Socket Host in config.app.ts
gulp configs --host localhost:3080
npm startnpm run ionicBasic commands to run your project are:
start backend: backend/ node server.js
start angular: npm start
start ionic: npm run ionic
Then navigate to:
Webapp: localhost:8080
Ionic: localhost:8100
Once you have started the webpack you will see the webpack-dashboard. Changes to file in the front end will automatically be built and shown in the webpack-dashboard. Changes to the backend wont take effect and you will have to restart server.js to show changes.
To Compile everything into dist/ for distro
npm run build
Compiles everything into www/
npm run ionic-build
*ionic-build has same Switches as ionic-serve
You can generate api docs (using TypeDoc) for your code with the following:
npm run docsWe use the standard component based approach. We combine files in the following areas; backend server, browser views, mobile views, and app services. Within the browser and mobile view folders we group singleton components and combined components that make up modules.
angular2-ionic2-webpack/
├──backend/ * Serverside Application, self-contained
│ ├──db/ * holds db connection files
│ │ └──db_knex_default_mysql.js * default database connection library
│ │
│ ├──modules/ * backend modules, restful routes and functionality
│ │ ├──login/ * backend login module pack
│ │ │ ├──crypto-imap.js * crypto library for imap authentication
│ │ │ ├──crypto-pdkdf2.js * crypto library for pdkdf encryption
│ │ │ └──login.restful.js * login restful endpoints
│ │ │
│ │ └──permission/ * backend permission module pack
│ │ ├──permission.model.js * permission functionality
│ │ └──permission.restful.js * permission restful endpoints
│ │
│ ├──.gitignore * ignore files for backend directory
│ ├──README.md * Server side Readme
│ ├──catchError.js * Sockets error catching
│ ├──package.json * what npm uses to manage it's dependencies
│ ├──sample.env * example .env file, needs to be copied to .env and modified
│ └──server.js * node backend starting point, `node server.js`
│
│
├──src/ * our source files that will be compiled to javascript
│ ├──browser/ * browser based view files for angular2 layouts
│ │ ├──app/ * WebApp: folder
│ │ │ ├──app.component.ts * a simple version of our App component components
│ │ │ ├──app.module.ts * root AppModule component
│ │ │ ├──app.routing.ts * specify root routing instructions
│ │ │ ├──main.dev.ts * development bootstraping
│ │ │ ├──main.prod.ts * production bootstraping
│ │ │ ├──polyfills.ts * our polyfills file
│ │ │ └──vendor.ts * our vendor file, add third party libraries here
│ │ │
│ │ │
│ │ ├──assets/ * any files you want copied to the public www directory
│ │ │ ├──img/ * public facing images
│ │ │ ├──index.html * index.html for public facing page
│ │ │ └──service-worker.js * placeholder for upcoming service-workers
│ │ │
│ │ │
│ │ ├──components/ * single components not part of a module
│ │ │ ├──home/ * sample homepage site view component
│ │ │ │ ├──home.css * homepage css styles
│ │ │ │ ├──home.html * homepage angular2 html
│ │ │ │ └──home.ts * homepage view component
│ │ │ │
│ │ │ └──login/ * sample login page view component
│ │ │ ├──login.css * login css styles
│ │ │ ├──login.html * login angular html
│ │ │ └──login.ts * homepage view component
│ │ │
│ │ │
│ │ ├──modules/ * grouped components part of a module
│ │ │ ├──headers * sample module for headers
│ │ │ │ ├──header * sample header component
│ │ │ │ │ ├──header.html
│ │ │ │ │ └──header.ts
│ │ │ │ │
│ │ │ │ ├──navbar * sample navbar component
│ │ │ │ │ ├──navbar.css
│ │ │ │ │ ├──navbar.html
│ │ │ │ │ └──navbar.ts
│ │ │ │ │
│ │ │ │ └──headers.module.ts * module imports and exports header and navbar
│ │ │ │
│ │ │ └──shared.module.ts * global shared modules
│ │ │
│ │ └──auth-guard.js * login systems @CanActivate browser authguard
│ │
│ │
│ ├──desktop/ * future home for angular-electron integration
│ │
│ │
│ ├──mobile/ * mobile view files for ionic2-angular2 layouts
│ │ ├──app/ * IonicApp folder
│ │ │ ├──app.component.ts * a simple version of our App component components
│ │ │ ├──app.module.ts * root AppModule component for Ionic
│ │ │ └──main.prod.ts * production bootstraping
│ │ │
│ │ ├──assets/ * any files you want copied to the public www directory
│ │ │ ├──icon
│ │ │ ├──manifest.json
│ │ │ └──service-worker.js
│ │ │
│ │ ├──pages/ * ionic view components
│ │ │ ├──about * sample ionic tabs project about page
│ │ │ ├──contact * sample ionic tabs project contact page
│ │ │ ├──home * sample ionic tabs project home page
│ │ │ └──tabs * sample ionic tabs project entry page
│ │ │
│ │ ├──theme/ * mobile interface themes
│ │ │ ├──app.core.scss
│ │ │ ├──app.ios.scss
│ │ │ ├──app.md.scss
│ │ │ ├──app.variables.scss
│ │ │ ├──app.wp.scss
│ │ │ └──variables.scss
│ │ │
│ │ └──index.html * index.html for public facing page
│ │
│ │
│ ├──services/ * services for retrieving api data from backend server
│ │ ├──api.ts * sample api angular2 service
│ │ └──login-service.ts * login service for angular2 auth-guard
│ │
│ └──style/ * global style libraries
│ └──app.scss * global app styles
│
│
├──tsconfig/ * tsconfig base files, copied to tsconfig.json with gulp
│ ├──browser.json * tsconfig file adjusted for angular2 compiles
│ └──ionic.json * tsconfig file adjusted for ionic2 compiles
│
│
├──.gitignore * ignore files for git repo
├──.htaccess * mod-rewrite instructions for Apache
├──CHANGELOG.md * list of changes made to repo
├──LICENSE * MIT License text
├──README.md * this file
├──config.app.ts * angular2 @Injectable ConfigApp, provides global config options
├──config.xml * ionic2 project description file
├──gulpfile.js * worker to modify configs, hooks for ionic
├──ionic-copy.config.js * ionic-app-scripts copy updated config file
├──ionic.config.json * ionic2 configuration
├──ionic.project * ionic2 project info
├──karma-shim.js * karam browser shim for unit tests
├──karma.conf.js * karma config for our unit tests
├──package.json * what npm uses to manage it's dependencies
├──protractor.conf.js * protractor config for our end-to-end tests
├──tsconfig.json * config that webpack uses for typescript
├──tslint.json * typescript lint config
├──typedoc.json * typescript documentation generator
├──web.config * IIS url rewrite instructions (http://www.iis.net/downloads/microsoft/url-rewrite)
└──webpack.config.js * webpack browser angular2 configuration filenpm testnpm run test-watchnpm start and check out localhost:8080 or whichever port you're using.npm run webdriver-startnpm run e2enpm run e2e-liveTo build your application, run:
npm run buildYou can now go to /dist and deploy that to your server!
You can generate api docs (using TypeDoc) for your code with the following:
npm run docsNo, 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.
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.
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 --saveAnd in vendor.ts add the following:
import 'bootstrap/dist/css/bootstrap.css';To take full advantage of TypeScript with autocomplete you would have to use an editor with the correct TypeScript plugins.
TypeScript 2.0.x includes everything you need. Make sure to upgrade, even if you installed TypeScript previously.
npm install --global typescriptWe have good experience using these editors: