ChocolateChip - A Compact Framework for Mobile Web Apps
For Version 3.9.2, continue below.
Please visit ChocolateChip-UI's Website for documentation and tutorials. This project includes examples for iOS, Android and Windows Phone 8 to help you get going.
The fastest way to get going with ChocolateChip-UI is to install the NPM module
chui. This will allow you to quickly create the type of ChocolateChip-UI project you want. Please visit NPM for directions on how to use it
You do not have to build ChocolateChipUI. This repository has all examples and test pre-built for you. To view the iOS examples, please use the Safari Browser. For Android, use Chrome. For Windows Phone, use IE 10 or MS Edge.
If you want or need to make modifications to the code for whatever reason, you'll need to build the files from the source code. For details how to do that, read on.
ChocolateChip-UI uses Gulpjs to build. This is a Node package, so you'll first need to have Node installed. After installing Nodejs, or if you already have it installed, on Mac OS X use the terminal to cd to the directory. On Windows you can use the Windows command prompt to do this. Once you are in the folder, run the following command in your terminal.
On Mac OS X, you'll need to run the command in your terminal with sudo to avoid installation errors:
sudo npm install -g gulp
For Windows, just run this:
npm install -g gulp
Enter your password when it requests. After you should see a number of Nodejs modules being installed in a folder called node_modules. You do not need node_modules in your final project. The node modules are there to enable the build process with Gruntjs.
Now that you have the node modules install, you can just type
gulp in the terminal and hit return/enter. This will kick off the build process, which will produce the following directories:
chui/ data/ demo/ examples-android/ examples-ios/ examples-win/ images/ node_modules/
If you're starting a new project, you only need the files in the chui folder. If you want to create a custom build, then just run any of the tasks:
gulp js android
gulp js ios
gulp js win
You can also build out just the examples for a particular platform:
If you intend to customize a theme for branding purposes, you should do so in the LESS files in the source. But instead of having to rebuild the theme each time, you can ask Gulp to watch the theme. That means every time you make a change and save a file, Gulp will rebuild the theme for you.
To watch all there themes, run:
To watch specific platform theme, run one of these:
You could also build a theme and watch it all at once:
gulp js android && gulp watch_android
gulp js ios && gulp watch_ios
gulp js win && gulp watch_win
If you want to use ChocolateChipJS instead of jQuery, you can just run the following command:
This will put the latest version of ChocolateChipJS in the chui folder and also output all examples to use ChocolateChipJS instead of jQuery. You can learn more about how to use ChocolateChipJS on our website.
You do not need Nodejs to use ChocolateChip-UI. Nodejs is only used to build the framework and examples from the source files.
Avoiding Carriage Returns in Commits
ChocolateChip-UI uses Unix linefeeds (LF) for new lines. Github for Windows adds carriage returns to linefeeds (CRLF). If you try to check in such files, Git will flag every line with changed new lines, which means practically everything. To avoid this we've added a .gitattributes file to the repository. This will prevent Github from converting the new lines on Windows.
If you are editing the source code on Windows, depending on the text editor you are using, or if you do a copy/paste, you may inadvertently introduce Windows carriage returns. Also some Grunt actions, such as concatenation with banners, automatically create newlines with carriage returns on Windows. When these carriage returns are added to the source code, they will show up as a changes at commit time. You can avoid this. Navigate to the ChocolateChip-UI repository in the command prompt, then execute these two Git commands:
git config core.eol lf git config core.autocrlf input
core.eol tells Git to always checkout this repository with LF. core.autocrlf tells Git to convert CRLF to LF on commit.