https://github.com/suchipi/require-browser

Easy-to-use require function for your browser
https://github.com/suchipi/require-browser

beginner-friendly browser commonjs commonjs-modules javascript modules require

Last synced: 2 days ago
JSON representation

Easy-to-use require function for your browser

• Host: GitHub
• URL: https://github.com/suchipi/require-browser
• Owner: suchipi
• License: mit
• Created: 2018-10-29T04:30:46.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-05-10T20:34:24.000Z (over 3 years ago)
• Last Synced: 2024-09-07T15:54:47.243Z (28 days ago)
• Topics: beginner-friendly, browser, commonjs, commonjs-modules, javascript, modules, require
• Language: JavaScript
• Size: 766 KB
• Stars: 21
• Watchers: 2
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `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](https://nodejs.org/).

![Screenshot showing require function in use in Chrome's DevTools console](https://user-images.githubusercontent.com/1341513/48318342-6ec7cb80-e5bc-11e8-8c73-b488439503b9.png)

## 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](https://webpack.js.org/) or [browserify](http://browserify.org/) with few or no code changes

- `require("fs")` works the same as in Node (via [`fs-remote`](https://www.npmjs.com/package/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](https://webpack.js.org/) to bundle your application.

## Usage

You must have [Node.js](https://nodejs.org/) 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:

![Screenshot of terminal output](https://user-images.githubusercontent.com/1341513/48318304-e34e3a80-e5bb-11e8-99be-6973471c33df.png)

## 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