Skip to content

Commit

Permalink
Updating references and build tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
daffl committed Dec 7, 2012
1 parent 47c02d7 commit 5e42113
Show file tree
Hide file tree
Showing 27 changed files with 103 additions and 315 deletions.
5 changes: 2 additions & 3 deletions .gitignore
@@ -1,13 +1,12 @@
.tmp*
cookbook/*
cookbook*
site/docs/*
scripts/key
.DS_Store
html/
.idea
selenium.log
packages/*
tmp/*
tmp*
node_modules
npm-debug.log
backbone
6 changes: 3 additions & 3 deletions build/tasks/docco.js
Expand Up @@ -6,10 +6,10 @@ var docco = require('docco');
module.exports = function(grunt) {
grunt.registerMultiTask('docco', 'Docco processor.', function() {
var _ = grunt.utils._;
var options = grunt.config(['docco', this.target]);
var options = grunt.config.process(['docco', this.target]);
var defaults = _.extend({
exclude : [/\.min\./]
}, grunt.config('docco')._options);
}, grunt.config.process('docco')._options);
grunt.verbose.writeflags(options, 'Options');
var done = this.async();
var src = grunt.file.expandFiles(this.file.src).filter(function(file) {
Expand All @@ -21,7 +21,7 @@ module.exports = function(grunt) {
return true;
});

docco.document(src, options.docco || {}, function(err, result, code){
docco.document(src, _.extend({}, defaults.docco, options.docco) || {}, function(err, result, code){
grunt.log.writeln("Doccoed [" + src.join(", ") + "]; " + err ? err : "(No errors)" + "\n" + result + " " + code);
done();
});
Expand Down
2 changes: 1 addition & 1 deletion can
Submodule can updated from fec3dd to cc918f
3 changes: 3 additions & 0 deletions grunt.js
@@ -0,0 +1,3 @@
module.exports = function (grunt) {

};
29 changes: 0 additions & 29 deletions jmvc/generate/templates/app/(application_name).css.ejs

This file was deleted.

Empty file.
Empty file.
5 changes: 0 additions & 5 deletions jmvc/generate/templates/app/fixtures/fixtures.js.ejs

This file was deleted.

15 changes: 0 additions & 15 deletions jmvc/generate/templates/app/funcunit.html.ejs

This file was deleted.

2 changes: 0 additions & 2 deletions jmvc/generate/templates/app/models/models.js.ejs

This file was deleted.

18 changes: 0 additions & 18 deletions jmvc/generate/templates/app/qunit.html.ejs

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion jmvc/generate/templates/app/test/funcunit/funcunit.js.ejs

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion jmvc/generate/templates/app/test/qunit/qunit.js.ejs

This file was deleted.

16 changes: 0 additions & 16 deletions jmvc/generate/templates/control/funcunit.html.ejs

This file was deleted.

Empty file.
1 change: 0 additions & 1 deletion jmvc/generate/templates/control/views/init.ejs.ejs

This file was deleted.

12 changes: 0 additions & 12 deletions jmvc/generate/templates/fixturemake.ejs

This file was deleted.

49 changes: 0 additions & 49 deletions jmvc/generate/templates/model/test/qunit/(underscore)_test.js.ejs

This file was deleted.

134 changes: 86 additions & 48 deletions readme.md
@@ -1,48 +1,86 @@
# JavaScriptMVC 3.3

## How to get (and contribute) JMVC

1. Start a new project in git.
2. Fork ....
http://github.com/jupiterjs/steal and
http://github.com/jupiterjs/jquerypp and
http://github.com/jupiterjs/funcunit and
http://github.com/jupiterjs/documentjs
3. Add steal, jquerymx, funcunit, and documentjs as submodules of your project...
git submodule add git@github.com:_YOU_/steal.git steal
git submodule add git@github.com:_YOU_/jquerypp.git jquery
git submodule add git@github.com:_YOU_/funcunit.git funcunit
git submodule add git@github.com:_YOU_/documentjs.git documentjs
4. Learn a little more about submodules ...
http://johnleach.co.uk/words/archives/2008/10/12/323/git-submodules-in-n-easy-steps
5. Make changes in steal or jmvc, and push them back to your fork.
6. Make a pull request to your fork.


## Getting Started with JMVC

1. Generate app:
./js steal/generate/app cookbook
2. Generate scaffold:
./js steal/generate/scaffold Cookbook.Models.Recipe
3. Add html to cookbook/cookbook.html:
<ul id='recipes'></ul>
<form id='create' action=''></form>
4. See your recipes app:
Open cookbook/cookbook.html in a browser.
5. Run functional tests in the browser:
Open cookbook/funcunit.html in a browser (turn off popup blockers).
6. Run functional tests with selenium:
./funcunit/run selenium cookbook/funcunit.html
7. Run unit tests in the browser:
Open cookbook/qunit.html in a browser.
8. Run unit tests with Rhino:
./funcunit/run envjs cookbook/qunit.html
11. Compress app:
./steal/js cookbook/scripts/build.js
12. Turn on production mode in callcenter.html and reload page:
src='../steal/steal.production.js?cookbook'
13. Generate docs:
./steal/js cookbook/scripts/doc.js
14. View docs:
Open cookbook/docs.html.
@page index JavaScriptMVC

<div class="top">
<div class="topCorner">
<div class="right"></div>
<div class="left"></div>
</div>
<div class="content">
<h1>JavaScriptMVC Documentation</h1>
</div>
<div class="bottomCorner">
<div class="right"></div>
<div class="left"></div>
</div>
</div>

JavaScriptMVC (JMVC) is a MIT licensed, client-side, JavaScript framework that
builds maintainable, error-free, lightweight
applications as quick as possible. It packs best-of-breed
libraries and tools that are guaranteed to work together. It
supports every browser that jQuery supports.

If you are new to the framework, this page followed by
the [tutorials] is the best place to start.

JMVC's goodies are broken down into four sub-projects:

- [canjs CanJS] - A client side MVC Framework
- [jquerypp jQuery++] - A collection of useful DOM helpers and special events for jQuery
- [stealjs StealJS] - JavaScript and CSS dependency management and build tools
- [FuncUnit FuncUnit] - Functional and unit testing framework
- [DocumentJS DocumentJS] - Documentation engine

The remainder of this page highlights each sub-project. Click
the the project links on the left for a more in-depth overview
of the sub-project.

## CanJS

[canjs CanJS] is a JavaScript framework that makes
building rich web applications easy and the MVC of
JavaScriptMVC. The library is extremely lightweight
(at only 11k minified and compressed) and full featured.

Everything you want and need to know about CanJS
[http://canjs.us can be found here.]

## jQuery++

[jquerypp jQuery++] is a collection of useful jQuery libraries that provide the
missing functionality necessary to implement and organize large-scale
jQuery applications. It provides low-level utilities for things that
jQuery doesn’t support.

The best way to get started is the [jQuery++ overview](http://jquerypp.com).

## StealJS

[stealjs StealJS] is a "code manager" that keeps code beautiful and organized
while developing and FAST for users in production. It's a collection of
command-line and browser-based utilities enabling you to:

- [steal load] JS, CSS, LESS, and CoffeeScript files and build them into a single production file.
- [steal.generate generate] an application file/folder structure, complete with test, build and documentation scripts.
- [steal.get install] 3rd party dependencies.
- [steal.clean clean and JSLint] your code.
- make your Ajax app [steal.html crawlable].
- log [steal.dev messages] in development that get removed in production builds.

[stealjs StealJS] is a stand-alone tool that can be used without the rest of JavaScriptMVC.

## FuncUnit

[funcunit FuncUnit] is a web application testing framework that provides automated unit and
functional testing. Tests are written and debugged in the browser with
FuncUnit's short, terse, jQuery-like API. The same tests can be instantly
automated, run by Envjs or Selenium.

FuncUnit also supports extremely accurate [Syn event simulation] on practically every browser and
system.

## DocumentJS

[DocumentJS DocumentJS] provides powerful JavaScript documenting
capabilities. This whole website is built with it! DocumentJS can document practically
anything. It's extensible. And with Markdown support, it's easy to document your code.
2 changes: 1 addition & 1 deletion site/docs.html
Expand Up @@ -69,7 +69,7 @@
mxui : 'https://github.com/jupiterjs/mxui'
};
DOCS_LOCATION = "docs/" //adds searchData to this
JMVCDOC_TIMESTAMP = 1354133637549;
JMVCDOC_TIMESTAMP = 1354211774827;
COMMENTS_LOCATION = 'http://jmvcs3.disqus.com/embed.js';
steal = {
loaded: ['documentjs/jmvcdoc/production.css']
Expand Down

0 comments on commit 5e42113

Please sign in to comment.