brayancruces/webapplate

A Mobile First WebApp fromework that help you quickly start the mobile web app development.

Webapplate

A Mobile First, full stack WebApp template that help you quickly start the maintainable mobile web app development.

                __                      __      __
 _      _____  / /_  ____ _____  ____  / /___ _/ /____
| | /| / / _ \/ __ \/ __ `/ __ \/ __ \/ / __ `/ __/ _ \
| |/ |/ /  __/ /_/ / /_/ / /_/ / /_/ / / /_/ / /_/  __/
|__/|__/\___/_.___/\__,_/ .___/ .___/_/\__,_/\__/\___/
                       /_/   /_/

current version: v1.0.0

Webapplate provide a ready-to-deploy project bootstrap settings for both hosted (dynamic/static website) and packaged (no server) webapp , with convention of file structure, express server-side support, and preconfigured helper tools like appcache generator, multi-locales and testframework.

Website inherit from Webapplate can be deployed to any host provider.

Demos

Here are some examples that start the development by webapplate:

• UI Demos , which is on Firefox Marketplace before Firefox OS device officially release.
• FxOS BMI , the BMI calculator demo, with offline support. Source is available.
• bgzla, Bugzilla monitor for Gaia project

Get Webapplate

Go to https://github.com/gasolin/webapplate website, click 'ZIP' button to download nodera template.

or you can use git command to clone Webapplate:

git clone https://github.com/gasolin/webapplate.git

Usage

Setup

1. install node.js

2. To fetch dependent packages, enter the webapplate folder and run

    $ npm install -g grunt-cli bower
    $ npm install
   

Develop Hosted webapp(With dynamic/static web Server)

1. To start the server, run

    $ node app.js
   

Now you can open browser and see the web page at localhost:8000 .

The default page is stored in /publish/index.html. Read Syntax doc to learn plenty of sensible defaults.

2. To autotest and generate appcache for offline usage, run

    $ grunt
   

All magics are well integrated and configurable in webapplate.

Develop Packaged webapp (No Server)

just drag /public/index.html into browser. Or select /public/manifest.webapp in Firefox OS Simulator.

Plus webapplate enable you to genergate the packaged webapp via command:

$ grunt pack

Read Deployment doc for further configurations.

Generate static webapp (Server independent - experimental)

Generate minimized static web app

$ grunt static

Do JavaScript lint check and generate document

$ grunt docs

Features

1. HTML5 Mobile Web App support in mind: Mobile friendly templates based on Mobile Boilerplate, MIME types, favicons and webapp manifest (Firefox OS).

2. WebApp ready: provide every elements that needs to apply your webapp to Firefox Marketplace, and provide Firefox webapp install detection script for self hosting.

• Support add WebApp to Homescreen from Chrome and Saffari mobile.
• Also provide the manifest file for Chrome App to Chrome Store.

3. Dynamic Server-side support based on express: Provide grade A speed web server/client configuration in yslow measurement.

4. Support offline appcache and packaged webapp generator via grunt.js that make offline webapp support easier.

5. multi-locales support via l20n

6. Integrate unittest with browser via mocha JS test framework

Read Documentation at https://github.com/gasolin/webapplate/wiki.

License

The MIT License

Credit: developers and designers from node.js, express, grunt.js, Firefox OS, font-awesome, bower, and people who involved in improving Web technologies.