https://github.com/capmousse/nagrant

Preconfigured vagrant box for nodejs apps in a minute, with minimal configuration
https://github.com/capmousse/nagrant

nodejs vagrant

Last synced: 3 months ago
JSON representation

Preconfigured vagrant box for nodejs apps in a minute, with minimal configuration

• Host: GitHub
• URL: https://github.com/capmousse/nagrant
• Owner: CapMousse
• License: mit
• Archived: true
• Created: 2017-01-13T16:08:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-09-30T13:52:55.000Z (about 7 years ago)
• Last Synced: 2024-09-30T06:24:15.584Z (3 months ago)
• Topics: nodejs, vagrant
• Language: Ruby
• Homepage:
• Size: 18.6 KB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Nagrant

[![Stable V1.1.0](https://img.shields.io/badge/stable-v1.1.0-blue.svg)](https://www.npmjs.com/package/nagrant)

![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)

## Intro

Nagrant is a completely disposable pre-package vagrant box that provide you a simple development environment to create nodejs servers without requiring your to install anything (except nodejs and vagrant). Box can be created an launched in a minutes, with a minimal configuration !

Nagrant can run on Linux, Windows and Mac and include Nodejs v8, MongoDB 3.4, MySQL and Redis. More will be added.

## How to use

You can either instal Nagrant as a global or local package.

- global : `nagrant make`

- local : `$(npm bin)/nagrant make`

## Command list :

	COMMANDS : 

	make --force --example --after	create nagrant box

	help                 	Show help

	ARGUMENTS : 

	--force                       	Force rewrite of Nagrant files

	--example                     	Include creation of Nagrant.yml.example file

	--after                       	Include creation of after script

	OPTIONS : 

	--quiet                      		Quiet mode

	-v, --verbose                		Verbose mode

## Requirements

Before using Nagrant, you must install Vagrant and any supported virtualization software (Virtualbox, VMWare or Parallels).

## Node

To add any node instance to the vagran box, you can edit the `node` property of the `Nagrant.yml` file.

	node:

	  - dir: /home/vagrant/node/

	    script: index.js

To send parameters to your node instance, you can use the `params` property. Any property will be set as environment variable reachable with `process.env`.

	node:

	  - dir: /home/vagrant/node/

	    script: index.js

	    params:

	   	  - PORT: 8080

	   	  - MONGODB_NAME: testproject

## Folders

To add any shared folders to the vagrant box, you can edit the `folders` property of the `Nagrant.yml` file.

	folders:

	  - map: ~/Directory

	    to: /home/vagrant/Directory

## Ports

This is a list of default ports fowarded to your Nagrant env:

- HTTP: 8000 → 80

- HTTPS: 44300 → 443

- MySQL: 33060 → 3306

- MongoDB: 27047 → 27017

- Redis: 63790 → 6379

**Fowarding additional pots**

	ports:

	  - from: 8080

	    to: 80

	  - from: 443

	    to: 44300