ViewitJS

Lightweight Modular NodeJS framework

To see all list of extensions and documentation please visit ViewitJS - Modules & Packages

Getting Started

To use the framework

const ViewitJS = require('viewit');
const server = new ViewitJS();

server.listen();
server.on('connect', () => server.logger('Listening on localhost:3000'));

If you want to specify host & port

const ViewitJS = require('viewit');
const server = new ViewitJS();

// Use Host from enviroment or pass your owns (Host & Port are not required)
const { HOST, PORT } = process.env;

server.listen(PORT, HOST);
server.on('connect', () =>
  server.logger(`Connect & listening on ${HOST}:${PORT}`)
);

Prerequisites

Before installing, download and install Node.js

V8 or higher is required.

Installing

To install use npm

npm install viewitjs

Running the tests

To run the test suite, first install the devDependencies then run npm test

npm install viewitjs
npm run test

Development

If you want to parcipate please visit viewitjs

Navigate to a project folder where you want to work and clone the repository

git fork [email protected]:viewit-studio/viewitjs.git viewitjs

Install dependencies

npm install

Create new branch and start work & enjoy the project

If you want to contribute for any project module or package please visit

ViewitJS - Modules & Packages

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We are in firsts stages of the development. If you want to contribute with this project please visit:

ViewitJS

If you want to contribute in the modules or packages of the framework please visit

ViewitJS - Modules & Packages

Authors

• Diego Londoño - Viewit Team

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• To all interested contributors