https://github.com/barzik/nodejs-boilerplate

Simple Vanilla Node.js BoilerPlate
https://github.com/barzik/nodejs-boilerplate

Last synced: 9 months ago
JSON representation

Simple Vanilla Node.js BoilerPlate

• Host: GitHub
• URL: https://github.com/barzik/nodejs-boilerplate
• Owner: barzik
• Created: 2014-10-15T09:07:05.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-10-15T09:14:23.000Z (over 11 years ago)
• Last Synced: 2025-09-05T20:24:56.367Z (9 months ago)
• Language: JavaScript
• Size: 97.7 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Node.js Simple Module BoilerPlate 

This module is basic vanilla boilerplate for Node.js modules. This boilerplate include only the basic

elements required for Node.js module.

## How to use

### The code

Replace MYMODULE string with your module name. change MYMODULE.js file in lib directory to your-module-name.js

and change the require in index.js to your-module-name.js.

### package.json

You may change the package.json manually, but you should run 

    npm init

    

## How to run

After the changes, clone your directory to your project_directory/node_modules. You can require('MYMODULE') as any 

module. For example, put in app.js the following code:

	

    var module = require('MYMODULE');

    module.publicFunction();

MYMODULE should be in node_modules directory.