atajo-ionic

Atajo Ionic Client

An Ionic3 module for interacting with Atajo ( http://www.atajo-mobility.com )

Installation

npm install --save atajo-ionic

Getting Started

1. Add AtajoModule to your app.module.ts :

...
import { AtajoModule } from 'atajo-ionic';
...
@NgModule({
  declarations: [ ... ],
  imports: [
    ...
    AtajoModule,
    ...
  ],
  bootstrap: [IonicApp],
  entryComponents: [ ... ],
  providers: [ ... ]
})

2. Initialize

import { Config, Socket, Update } from 'atajo-ionic';

...
@Component({
  templateUrl: 'app.html'
})
export class MyApp {
  rootPage: any = ...;

  constructor(
    ...
    config: Config,
    socket: Socket,
    update: Update
    ...
  ) {
  
    update.isSuccessful(); // flags an update (if there was one) as successful

    platform.ready().then(() => {

      update.checkForUpdate(); // checks if there is new remote code
      
      ...
      
      
      //initialize the remote configuration with your domain 
      config.initialize("mydomain").then(  
        () => { 
           //connect the socket
           socket.connect(); 
        },
        error => { ... }
      ); 
      
      ...
      
     });
  }


}

Examples:

TODO

Docs

TODO

Developing (Using the module locally)

METHOD 1

1. Build the module and clone package.json

npm run build; node scripts/copy-package.js

2. Link it out

npm link; 

3. Link it in

cd <your-project-dir>; npm link atajo-ionic

METHOD 2

1. Build this module

npm run build; node scripts/copy-package.js

2. In your ionic projects package.json dependencies, map the newly created dist directory :

    "dependencies": {
       ...
        "atajo-ionic": "file:<path-to-this-repo>/atajo-ionic/dist", 
       ...
    }

3. (Remove and) Install the module

rm -rf node_modules/atajo-ionic; npm i

Repeat Steps 1 and 3 to load your changes into the test app.

Contributing

• Submit an Issue!
• Submit a Pull Request!
• Submit a Funny!