Difference between revisions of "Sugar Cordova"

From Sugar Labs
Jump to navigation Jump to search
(Created page with "== INSTRUCTIONS TO SET UP SUGAR CORDOVA == BELOW PROCEDURE IS FOR LINUX (MUST RUN FOR MAC TOO) : SETTING UP CORDOVA DEVELOPMENT ENVIRONMENT : Pre-Requirements : must have ...")
 
Line 1: Line 1:
 
== INSTRUCTIONS TO SET UP SUGAR CORDOVA ==
 
== INSTRUCTIONS TO SET UP SUGAR CORDOVA ==
  
BELOW PROCEDURE IS FOR LINUX (MUST RUN FOR MAC TOO) :
+
=== BELOW PROCEDURE IS FOR LINUX (MUST RUN FOR MAC TOO) : ===
  
SETTING UP CORDOVA DEVELOPMENT ENVIRONMENT :  
+
==== SETTING UP CORDOVA DEVELOPMENT ENVIRONMENT : ====
  
 
Pre-Requirements : must have node and npm installed
 
Pre-Requirements : must have node and npm installed
Line 15: Line 15:
 
4. cd to cordova-plugman, and repeat the steps for cordova-cli here - ( issuing npm install - same way to correct if any error , issue npm link cordova-lib)
 
4. cd to cordova-plugman, and repeat the steps for cordova-cli here - ( issuing npm install - same way to correct if any error , issue npm link cordova-lib)
  
ADDITION FOR ADDING THE SUGAR PLATFORM
+
==== ADDITION FOR ADDING THE SUGAR PLATFORM ====
  
 
1. Add the following in cordova-cli/node_modules/cordova-lib/src/cordova/platforms.js [Note the s in platforms, it differentiates from platform.js] :
 
1. Add the following in cordova-cli/node_modules/cordova-lib/src/cordova/platforms.js [Note the s in platforms, it differentiates from platform.js] :
Line 39: Line 39:
 
https://drive.google.com/file/d/0BxC58bMp7xjuNnpWTkRNRFNnY28/edit?usp=sharing
 
https://drive.google.com/file/d/0BxC58bMp7xjuNnpWTkRNRFNnY28/edit?usp=sharing
  
Now to run and check :
+
==== RUN AND CHECK ====
  
 
1.Go to cordova-cli/bin and run the command : ./cordova create new_project
 
1.Go to cordova-cli/bin and run the command : ./cordova create new_project
Line 55: Line 55:
  
  
FOR WINDOWS :
+
=== FOR WINDOWS ===
 +
 
 +
==== SETTING CORDOVA CLI AND ADDING SUGAR ====
 +
 
 
The setting up of cordova is same (get the nodejs msi to install both node and npm)
 
The setting up of cordova is same (get the nodejs msi to install both node and npm)
 
​​
 
​​
Line 81: Line 84:
 
https://drive.google.com/file/d/0BxC58bMp7xjuNnpWTkRNRFNnY28/edit?usp=sharing
 
https://drive.google.com/file/d/0BxC58bMp7xjuNnpWTkRNRFNnY28/edit?usp=sharing
  
Now to run and check :
+
==== RUN AND CHECK ====
  
 
1.Go to cordova-cli\bin and type : cordova create <prj_directory> <prj_id> <prj_name>
 
1.Go to cordova-cli\bin and type : cordova create <prj_directory> <prj_id> <prj_name>

Revision as of 10:24, 22 July 2014

INSTRUCTIONS TO SET UP SUGAR CORDOVA

BELOW PROCEDURE IS FOR LINUX (MUST RUN FOR MAC TOO) :

SETTING UP CORDOVA DEVELOPMENT ENVIRONMENT :

Pre-Requirements : must have node and npm installed

1. Git clone : https://github.com/apache/cordova-cli , https://github.com/apache/cordova-lib and https://github.com/apache/cordova-plugman in a directory

2. Go inside cordova-lib, you'll find another cordova-lib inside it, issue the command npm install, npm link inside it.

3. Now cd to cordova-cli, and issue npm install in it then issue npm link cordova-lib

4. cd to cordova-plugman, and repeat the steps for cordova-cli here - ( issuing npm install - same way to correct if any error , issue npm link cordova-lib)

ADDITION FOR ADDING THE SUGAR PLATFORM

1. Add the following in cordova-cli/node_modules/cordova-lib/src/cordova/platforms.js [Note the s in platforms, it differentiates from platform.js] :

'sugar':{ parser: './metadata/sugar_parser', url : 'https://github.com/puneetgkaur/sugar-cordova.git', version: '3.5.0' }


2.Add the following to cordova-cli/node_modules/cordova-lib/src/plugman/platforms.js :

'sugar': require('./platforms/sugar')

3. Add the sugar_parser.js to cordova-cli/node_modules/cordova-lib/src/cordova/metadata from : https://github.com/puneetgkaur/cordova-lib/blob/master/src/cordova/metadata/sugar_parser.js

4. Add sugar.js to cordova-cli/node_modules/cordova-lib/src/plugman/platforms https://github.com/puneetgkaur/cordova-lib/blob/master/src/plugman/platforms/sugar.js

5.Unzip and add the sugar directory to home/.cordova/lib https://drive.google.com/file/d/0BxC58bMp7xjuNnpWTkRNRFNnY28/edit?usp=sharing

RUN AND CHECK

1.Go to cordova-cli/bin and run the command : ./cordova create new_project

2. cd to the new_project directory created inside the bin folder

  There run the command :

.././cordova platform add sugar

4. Then to build run :

.././cordova build sugar

The .xo generated would be present in cordova-cli/bin/new_project/platforms/sugar/cordova/HelloCordova.xo


FOR WINDOWS

SETTING CORDOVA CLI AND ADDING SUGAR

The setting up of cordova is same (get the nodejs msi to install both node and npm) ​​ ​ 1. Add the following in cordova-cli\node_modules\cordova-lib\src\cordova\platforms.js [Note the s in platforms, it differentiates from platform] :

'sugar':{ parser: './metadata/sugar_parser', url : 'https://github.com/puneetgkaur/sugar-cordova.git', version: '3.5.0' }

2.Add the following to cordova-cli\node_modules\cordova-lib\src\plugman\platforms.js :

'sugar': require('./platforms/sugar')


3. Add the sugar_parser.js to cordova-cli\node_modules\cordova-lib\src\cordova\metadata https://github.com/puneetgkaur/cordova-lib/blob/master/src/cordova/metadata/sugar_parser.js

4. Add sugar.js to cordova-cli\node_modules\cordova-lib\src\plugman\platforms https://github.com/puneetgkaur/cordova-lib/blob/master/src/plugman/platforms/sugar.js

5.Add the sugar directory to C:\Users\<your user name>\.cordova\lib https://drive.google.com/file/d/0BxC58bMp7xjuNnpWTkRNRFNnY28/edit?usp=sharing

RUN AND CHECK

1.Go to cordova-cli\bin and type : cordova create <prj_directory> <prj_id> <prj_name>

2. cd to the project directory created inside the bin folder

3.There run the command : ..\cordova platform add sugar

4. Then to build run : ..\cordova build sugar


NOTE : the windows users must install 7zip and set the environment variable ZIPCOMMAND with the command : set ZIPCOMMAND="c:\Program Files\7-Zip\7z.exe" a -r -tzip -aoa before issuing the cordova build command