Skip to content

Jacek-Kurasiewicz/ionic2-seed

 
 

Repository files navigation

Introduction

Join the chat at https://gitter.im/mgechev/angular2-seed Dependency Status devDependency Status Build Status

A seed project for Ionic 2 andAngular 2 apps based on https://github.com/mgechev/angular2-seed

It is something similar to the AngularJS Quick Start but does the entire build with gulp.

Note: Angular 2.0 is not production ready yet! This seed project is perfect for playing around with the latest versions but do not start new projects with it since a lot of new changes are going to be introduced until the framework is officially released.

How to start

Note that this seed project requires node v4.x.x or higher and npm 3.x.x.

git clone https://github.com/mgechev/angular2-seed.git
cd angular2-seed
npm install   # or `npm run reinstall` if you get an error
npm start     # start with --env dev
npm run docs      # api document for app

Does not rely on any global dependencies.

Directory Structure

.
├── LICENSE
├── README.md
├── app
│   ├── bootstrap.ts
│   ├── components
│   │   ├── about
│   │   │   ├── about.html
│   │   │   ├── about.ts
│   │   │   └── about_spec.ts
│   │   ├── app
│   │   │   ├── app.css
│   │   │   ├── app.html
│   │   │   ├── app.ts
│   │   │   └── app_spec.ts
│   │   └── home
│   │       ├── home.css
│   │       ├── home.html
│   │       ├── home.ts
│   │       └── home_spec.ts
│   ├── index.html
│   ├── services
│   │   ├── name_list.ts
│   │   └── name_list_spec.ts
│   ├── system.config.js
│   └── typings.d.ts
├── gulpfile.ts
├── karma.conf.js
├── package.json
├── test
│   ├── components
│   │   ├── about
│   │   │   ├── about.js
│   │   │   └── about_spec.js
│   │   ├── app
│   │   │   ├── app.js
│   │   │   └── app_spec.js
│   │   └── home
│   │       ├── home.js
│   │       └── home_spec.js
│   └── services
│       ├── name_list.js
│       └── name_list_spec.js
├── test-main.js
├── tools
│   ├── config.ts
│   ├── preinstall.js
│   ├── tasks
│   │   ├── build.csslib.dev.ts
│   │   ├── build.docs.ts
│   │   ├── build.fonts.ts
│   │   ├── build.index.dev.ts
│   │   ├── build.js.dev.ts
│   │   ├── build.jslib.dev.ts
│   │   ├── build.sass.dev.ts
│   │   ├── build.test.ts
│   │   ├── clean.ts
│   │   ├── karma.start.ts
│   │   ├── npm.ts
│   │   ├── server.docs.ts
│   │   ├── server.start.ts
│   │   ├── tsd.ts
│   │   ├── tslint.ts
│   │   ├── watch.dev.ts
│   │   ├── watch.serve.ts
│   │   └── watch.test.ts
│   ├── typings
│   │   ├── connect-livereload.d.ts
│   │   ├── gulp-load-plugins.d.ts
│   │   ├── karma.d.ts
│   │   ├── tiny-lr.d.ts
│   │   ├── ng2_test.d.ts
│   │   ├── open.d.ts
│   │   ├── run-sequence.d.ts
│   │   ├── slash.d.ts
│   │   └── yargs.d.ts
│   ├── utils
│   │   ├── server.ts
│   │   ├── tasks-tools.ts
│   │   ├── template-injectables.ts
│   │   └── template-locals.ts
│   └── utils.ts
├── tsconfig.json
├── tsd.json
└── tslint.json

Configuration

Default application server configuration

var PORT             = 5555;
var LIVE_RELOAD_PORT = 4002;
var DOCS_PORT        = 4003;
var APP_BASE         = '/';

Configure at runtime

npm start -- --port 8080 --reload-port 4000 --base /my-app/

Now to extend?

If you want to use your custom libraries:

npm install my-library --save
vim tools/config.js

Add reference to the installed library in PATH.src.jslib (or whatever you like).

Running test

npm test

# Debug - In two different shell windows
npm run build.test.watch      # 1st window
npm run karma.start           # 2nd window

Contributing

Please see the CONTRIBUTING file for guidelines.

Contributors

mgechev ludohenin tarlepp NathanWalker jesperronn aboeglin
mgechev ludohenin tarlepp NathanWalker jesperronn aboeglin
ryzy natarajanmca11 jerryorta-dev JakePartusch larsthorup TuiKiken
ryzy natarajanmca11 jerryorta-dev JakePartusch larsthorup TuiKiken
evanplaice ultrasonicsoft johnjelinek tandu markharding mjwwit
evanplaice ultrasonicsoft johnjelinek tandu markharding mjwwit
philipooo redian robertpenner sclausen butterfieldcons jgolla
philipooo redian robertpenner sclausen butterfieldcons jgolla
dstockhammer
dstockhammer

Change Log

You can follow the Angular 2 change log here.

License

MIT

Packages

No packages published

Languages

  • TypeScript 40.3%
  • HTML 29.2%
  • CSS 16.5%
  • JavaScript 14.0%