Giter Club home page Giter Club logo

jquery-node-amd-builder_03_2024's Introduction

amd-builder

This project aims at providing a Node.s service to build bundles out of AMD projects in a Git repository. This was developed for building jQuery Mobile bundles. Initial checkout as well as workspace creation have to be done manually.

API v1

/v1/{project}/{repo}

Fetch the latest version of the repo from the default remote.

/v1/{project}/{repo}/{ref}

Force checkout the ref into the {project}/{ref}/{repo} workspace if it exists.

/v1/dependencies/{project}/{repo}/{ref}

Traces 1st level dependencies.

URL arguments are:

  • baseUrl: The baseUrl for module name to file resolution
  • names: An optional comma separated list of modules to include in the dependency map. If it's not specified, the service will compute the dependency map for all the .js files in the baseUrl directory.

/v1/bundle/{project}/{repo}/{ref}/{name}?

name is the name of the file generated it defaults to repo.js

  1. name has extension .js (default) calls require.js to build the js bundle
  2. name has extension .css will resolve css dependencies through the //css: metadata and return a css bundle
  3. name has extension .zip will do all of the above in both optimize and non-optimized and return a zip file with 4 files in it

Builds a bundle for this repository's ref

URL arguments are:

  • baseUrl: The baseUrl for module name to file resolution
  • include: A comma separated list of modules to include in the bundle
  • exclude: A comma separated list of modules to exclude from the bundle
  • optimize: true or false

Setup an instance for your project

Perform all the following operations in the node-amd-builder main folder.

  1. Clone a bare repo of your project:

    mkdir repos
    cd repos
    git clone --bare [email protected]:yourname/yourproject.git
    
  2. Now create the staging directory:

    mkdir -p staging
    
  3. Install the dependencies with npm install

  4. Start the service:

    node server.js -r "$(pwd)/repos" -s "$(pwd)/staging"
    
  5. Add a post_receive hook to the your GitHub repo pointing at http://instance:3000/post_receive

Setup an instance for jQuery Migrate

Perform all the following operations in the node-amd-builder main folder. Make sure you use Node.js v14.14.0 or higher.

  1. Install the dependencies with npm install

  2. Invoke:

    scripts/setup-mobile.js
    
  3. Start the service:

    node server.js -r "$(pwd)/repos" -s "$(pwd)/staging"
    

    Invoke just node server.js --help to see other available options.

  4. Add a post_receive hook to the your GitHub repo pointing at http://instance:3000/post_receive (only needed if you don't checkout tags manually as described above)

Author

endorse

Credits

Thanks to:

  • Jive Software - my employer - for letting me work on cool projects like this

jquery-node-amd-builder_03_2024's People

Contributors

gseguin avatar dependabot[bot] avatar mgol avatar gnarf avatar brianwarner avatar krinkle avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.