Create README.md

This commit is contained in:
Sagi Dayan 2015-01-20 12:29:49 +02:00
parent 3eba59117b
commit 6fe046baff

57
www/README.md Normal file
View file

@ -0,0 +1,57 @@
JCE Manager (Moblie Version)
===================
This app was created in a few days while trying to learn [AngularJS](https://angularjs.org/) and Hybrid development technology.
This app was inspired by the [JCE Manager Project](https://github.com/liranbg/JceManager) written by me and [Liran Ben-Gida](https://github.com/liranbg ).
The JCE Official Mobile app was bad in my opinion so I wanted to do it right.
>>At the moment the app is still in Develop mode, If you would like to try it you can build it yourself or e-mail me to get in the testers group.
What you will need to start Coding & Building
=====================================
- [NodeJS](http://nodejs.org/)
- [Cordova & Ionic Framework](http://ionicframework.com/getting-started/)
##After you have got NodeJS
open up a terminal:
```shell
$ npm install -g cordova ionic
```
>You night need superuser privileges . use "sudo"
now go to your Working directory and clone the Repo by:
```(shell)
$ git clone https://github.com/sagidayan/JCE-Mobile-App.git
```
this will create a new directory and copy all the files in the project.
Run In Browser
===
to run the app in your browser type:
```(shell)
../JCE-Mobile-App/$ ionic serve
```
Build for mobile
====
You will need Android SDK or Mac+x-code for the platform of your choice.
for android:
```shell
../JCE-Mobile-App/$ ionic platform add android
../JCE-Mobile-App/$ ionic build android
```
the same goes to iOS...
Where is the code?
====
If you would like to change / modify the code. make sure you play in the www folder.
that is where all the HTML and Javascript files are.