The Honors Club
NOTE:
Review the repository tangoclinh1995/sample-ionic-project to understand about the code structure
There are some files named dummy in some directories. They were created to help showcase the code structure. Just ignore it when doing development*
Navigate into the directory of the repository (using cd command)
Run the following commands:
npm install # Install necessary NPM packages
ionic state reset # Install necessary ionic plugins, add Android & IOS platform
bower install # Install necessary bower librariesNOTE: During Bower installation process, if you are prompted to ask what version of AngularJS (or version of any library which depends on AngularJS) to use, please ALWAYS REMEMBER to choose Angular 1.5.3 (or the version of the other library which depends on Angular 1.5.3)
Create a file named firebase_init.js in the www directory with the following content:
firebase.initializeApp({
apiKey: <YOUR_API_KEY>,
authDomain: <YOUR_AUTH_DOMAIN>,
databaseURL: <YOUR_DATABASE_URL>,
storageBucket: <YOUR_STORAGE_BUCKET>,
messagingSenderId: <YOUR_MESSAGE_SENDER_ID>
});For more information about what parameters should be used here, please visit team's Slack channel.
NOTE: This file is ignored by Git, so you need to create it by yourself. The purpose of this is to protect Firebase authentication information and speed up development time (as each developer can experiment their code differently on their OWN database)
To test for IOS, run the following commands on a Mac:
ionic build ios
ionic emulate iosThis should open up the IOS emulator with the app
During the development process, sometimes you want to use extra Javascript libraries. In an Ionic project, you do this using Bower:
bower install <JS_LIBRARY_NAME>NOTE: During Bower installation process, if you are prompted to ask what version of AngularJS (or version of any library which depends on AngularJS) to use, please ALWAYS REMEMBER to choose Angular 1.5.3 (or the version of the other library which depends on Angular 1.5.3)
The newly-installed library will be put in *www/lib directory.
After this step:
Add the suitable <script> tag to www\index.html file to enable your newly-installed Javascript
libraries. This <script> tag should be in the <head> part of the file. Example of a correct tag:
<script src="https://github.com/tangoclinh1995/thehonorclub-mobileapp/raw/master/lib/collide/collide.js"></script>In the files part of karma.conf.js, add paths of the Javascript files which are just added by you
using the <script> tag above. For example:
files: [
...
"www/lib/collide/collide.js",
...
]Navigate into the directory of the repository (using cd command)
Run Gulp Watch:
./node_modules/.bin/gulp watch # Watch for files change and automatically rebuild the projectOpen Ionic live reload in a terminal different from the one running Gulp Watch:
ionic serveNavigate into the directory of the repository (using cd command)
Run Karma:
karma startCreate a new Firebase database separated from this project's main Firebase database. This database is going to be used for TESTING PURPOSE ONLY
Take a look at the file unit_testing/firebase_test.js in the sample project tangoclinh1995/sample-ionic-project for better understanding of the testing procedure.