Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Implementation of browserside CommonJS specs (Modules, Packages and Transport)

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 docs
Octocat-spinner-32 examples
Octocat-spinner-32 jsbuilder
Octocat-spinner-32 src
Octocat-spinner-32 tests
Octocat-spinner-32 .gitignore
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 apprequire-debug.js
Octocat-spinner-32 apprequire.js
Octocat-spinner-32 apprequire.jsb3
README.md

AppRequire

AppRequire is a generic CommonJS Environment Framework implementation to test the philosopy of the proposed framework description.

Use

The only thing that needs to be done to use CommonJS modules and packages in every browser/server side scripting program is including one of the following scripts depending on your environment:

  • apprequire.js - Implementing the total CommonJS environment (Modules, most used Module Loaders, Packages, main Package Loaders and Registry Connectors) with basic system modules (system and test)
  • apprequire-debug.js - An uncompressed version of apprequire.js with coding comments.
  • apprequire-lite.js - Implementing a lite version of the CommonJS environment (Modules, basic Module Loader, basic Packages, basic Package Loader and basic Registry Connector)
  • apprequire-lite-debug.js - An uncompressed version of apprequire-lite.js with coding comments.

There are two way's to startup the system, use the data-context attribute or by calling exports.boot(cfg)

data-context example (examples/datacontext):

<script data-context="{&#34;location&#34;: &#34;./modules/&#34;, &#34;main&#34;: &#34;program&#34;, &#34;timeout&#34;: 2000}" src="../apprequire-debug.js"></script>

exports.boot example (examples/boot):

<script src="../apprequire-debug.js"></script>
<script>
    exports.boot({
        "location": "./modules/", 
        "main": "program",
        "timeout": 2000
    });
</script>

Configuration JSON

Future work: describing all the configuration options

Documentation

Contribute

Collaboration Platform: https://github.com/stolsma/apprequire

Collaboration Process:

  1. Discuss your change on the github issue list
  2. Write a patch on your own
  3. Send pull request on github
  4. Discuss pull request on github to refine

You must explicitly license your patch by adding the following to the top of any file you modify in order for your patch to be accepted:

//  - <GithubUsername>, First Last <Email>, Copyright YYYY, MIT License

Credits

This project would not be possible without the following:

  • CommonJS - For framing requirements into specifications
  • BravoJS - For a pure and clean CommonJS Modules/2 loader implementation
  • NodeJS - For providing a solid runtime used by default
  • Firefox - For providing an amazing browser platform
  • Firebug - For the amazing developer tool it is
  • nodules - For implementing and refining CommonJS Packages/Mappings/C
  • pinf - For implementing and refining various designs and specifications
  • Github - For igniting a generation of collaborative development
  • JavaScript - For the awesome language it is

This project uses code from:

Documentation License

Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License

Copyright (c) 2011 Sander Tolsma

Code License

MIT License

Copyright (c) 2011 Sander Tolsma

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.