Giter VIP home page Giter VIP logo

ionic-example's Introduction

Using TypeORM in an Ionic project

You can use TypeORM in connection with the cordova-sqlite-storage plugin in your Ionic app. This project demonstrates how that would work.

Installation

To run this example in production or development mode you have to make sure, ionic and cordova are installed globally on your machine. After that you can install all necessary dependencies for running this example.

  1. Check if npm is installed. Otherwise please install node.js and npm.
npm -v
  1. Install ionic and cordova command line interface globally.
npm install -g cordova ionic
  1. Install all dependencies listed in package.json.
npm install

Running the example in your browser

ionic serve

Running the example on your device

  1. Add an iOS or Android to the project.
ionic cordova platform add ios 
# or 
ionic cordova platform add android
  1. Run the app on your device.
ionic cordova run ios
# or
ionic cordova run android

For further information please read ionic's deployment guide.

screenshot

Using TypeORM in your own app

  1. Install the plugin
ionic cordova plugin add cordova-sqlite-storage --save
  1. Install TypeORM
npm install typeorm --save
  1. Install node.js-Types
npm install @types/node --save-dev
  1. Add "typeRoots": ["node_modules/@types"] to your tsconfig.json under compilerOptions

  2. Create a custom webpack config file like the one included in this project to use the correct TypeORM version and add the config file to your package.json (Required with TypeORM >= 0.1.7)

Limitations to TypeORM when using production builds

Since Ionic make a lot of optimizations while building for production, the following limitations will occur:

  1. Entities have to be marked with the table name (eg @Entity('table_name'))

  2. getRepository() has to be called with the name of the entity instead of the class (eg getRepository('post') as Repository<Post>)

  3. Date fields are not supported:

@Column()
birthdate: Date;

ionic-example's People

Contributors

daniel-lang avatar nextlevelshit avatar pleerock avatar pmargreff avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.