Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crazy-max/nodejs-portable

Node.js portable on Windows
https://github.com/crazy-max/nodejs-portable

golang node-portable nodejs portable windows

Last synced: 2 months ago
JSON representation

Node.js portable on Windows

Awesome Lists containing this project

README

        

> For more portable applications, checkout [Portapps](https://portapps.io) !


GitHub release
Total downloads
Build Status
Go Report

Become a sponsor
Donate Paypal

Read this in other languages: [English](README.md), [简体中文](README.zh-cn.md).

## :warning: Abandoned project

This project is not maintained anymore and is abandoned. Feel free to fork and make your own changes if needed.

Thanks to everyone for their valuable feedback and contributions.

## About

A single EXE written in [Go](https://golang.org/) to make [Node.js](http://nodejs.org/) portable on Windows systems.

Tested on Windows 7, Windows 8.1 and Windows 10.

![](res/screenshots/main-20170915.gif)
> Main window of Node.js Portable

Configuration file `nodejs-portable.conf` is generated at first launch:

![](res/screenshots/files-20171227.png)

## Installation

* Download the [latest release](https://github.com/crazy-max/nodejs-portable/releases/latest).
* Put `nodejs-portable.exe` in a new empty folder.

## Getting started

Run `nodejs-portable.exe`, then choose task:
* **1** to install node.js by entering version and architecture.
* **2** to launch Node.js shell.

> If you have already installed Node.js, create a folder named `app` and put your node.js environment inside, then launch `nodejs-portable.exe`. (See [#35](https://github.com/crazy-max/nodejs-portable/issues/35))

### Config file `nodejs-portable.conf`

* `workPath` : Shell working dir (can be relative to `nodejs-portable.exe`).
* `customPaths` : Array of custom paths that will be placed in the `PATH` environment variable (paths can be relative to `nodejs-portable.exe`).
* `immediateMode`: Set this to `true` if you want to use node shell immediately.
* `shell`: Shell to be used. Can be `cmd` (default) or `powershell`.

> If an exception happened, take a look into `nodejs-portable.log` for further information.

### Command line

Node.js Portable can be used through the command line to inject arguments directly to node:

```
$ nodejs-portable.exe --version
v9.5.0
```

> Take a look into `nodejs-portable.log` if you have any issue.

## Building

* Install [Go](https://golang.org/dl/) 1.12+
* Add Go to your PATH (ex. `C:\Go\bin`)
* Install latest version of [Mage](https://github.com/magefile/mage/releases/latest)
* Add Mage to your PATH
* Clone this repository
* Run `mage build` inside. The artifact will be available in `bin`

## Contributing

Want to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues.

You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) or by
making a [Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely!

Thanks again for your support, it is much appreciated! :pray:

## License

MIT. See `LICENSE` for more details.

USB icon credit to [Dakirby309](http://dakirby309.deviantart.com/).