require-browser v0.1.4

require-browser

The require-browser package gives you an easy-to-use require function for your browser that behaves the same as the one in Node.js.

Features

• Works without installation via npx
• Makes it easy to get started developing with modules now
• Works on Windows, Linux, and macOS
• Can later be replaced with Webpack or browserify with few or no code changes
• require("fs") works the same as in Node (via fs-remote)
• require("os"), require("buffer"), and other Node builtin modules will be automatically replaced with browser-compatible shims
• Supports lookup via node_modules, so you can use npm to manage your dependencies

require-browser is not suitable for use in production (it's insecure), but makes it easy to get started developing in the browser. Once you want to run your code in production, I suggest using Webpack to bundle your application.

Usage

You must have Node.js 8.12.0 or higher installed, then run the following in your terminal or command prompt:

npx require-browser

A server will start and further instructions will be printed in your terminal/command prompt:

Installation

If you want to install require-browser globally so you don't need to use npx, run the following in your terminal or command prompt:

npm install -g require-browser

Then you can run it without npx:

require-browser

CLI Options

$ require-browser --help
Options:
  --help       Show help                                               [boolean]
  --version    Show version number                                     [boolean]
  --fs-port    Port to run the fs-remote server on
                                             [number] [required] [default: 3001]
  --http-port  Port to host files over http from
                                             [number] [required] [default: 3002]
  --root-dir   Directory where index.html can be found and the global require
               function will resolve relative to
                                              [string] [required] [default: "."]

License

MIT