kwaeri-server

A Massively Modified Open Source Project by kirvedx

The @kwaeri/server component for the @kwaeri/node-kit application platform

TOC

• The Implementation
• Getting Started
  • Installation
  • Usage
• How to Contribute Code
• Other Ways to Contribute
  • Bug Reports
  • Vulnerability Reports
    • Confidential Issues
  • Donations

The Implementation

kwaeri/server reinvents and modernizes the server portion of the node-kit application platform. It expects to be fed a configuration (specifically, the contents of the development or production properties), one that is in the root of a project which makes use of kwaeri/server.

The server component also requires that several other required components be bundled with the configuration, prefereably through a project's initialization process, such as:

• A Router component
• A Session component
  • Requiring a compatible Session Store
• A Controller component
• A Model component
• A Renderer component
• A Utility component

As the server component was originally baked into the nk module, its usage was entirely controlled by it. As we discern the process for decoupling the individual components which make up a kwaeri application, we'll begin to simplify the act of doing so, and provide documentation for utilizing each component individually.

Getting Started

NOTE

This module is not ready for production, but published for testing and development purposes. It is in a beta state that is intended for allowing a larger audience of users to try out anything that may already be available, but please be aware that there is likely many aspects of the platform which are not working and/or completely broken; This is intended to allow users to find and report such issues so that they may be fixed. Updated documentation and complete examples and tutorials for getting started will be provided as the platform rewrite nears completion.

Installation

kwaeri/node-kit wraps the various components under the kwaeri scope and provides a single point of entry for both the kwaeri/node-kit application framework and kwaeri/cli component of the kwaeri platform.

kwaeri/cli wraps the various user-executable framework components under the kwaeri scope, and provides a single point of entry to the CLI tooling of the kwaeri platform.

However, if you wish to install kwaeri/server and utilize it specifically - perform the following steps to get started:

Install @kwaeri/server:

npm install @kwaeri/server

Usage

Basic usage of the server requires nothing more than to import it:

import { Server } from '@kwaeri/server';

However, the server component is intended to be used in conjunction with several other components which make up the node-kit framework as part of the kwaeri application platform. This is done officially via the kwaeri/node-kit entry point.

To user the server component directly, you'll need to first include the component, and follow up with providing its complimenting components as part of its configuration. Here are the imports used by node-kit to satisfy the required component facilities:

// INCLUDES
import { Server } from '@kwaeri/server';
import { Router } from '@kwaeri/router';
import { Session } from '@kwaeri/session';
import { Controller } from '@kwaeri/controller';
import { Model } from '@kwaeri/model';
import { Driver } from '@kwaeri/driver';
import { Renderer } from '@kwaeri/renderer';
import { Utility } from '@kwaeri/utility';

// npm install --save sjcl,
import * as sjcl from 'sjcl';

// npm install --save-dev @kwaeri/md5-js
import { crypt_md5 } from '@kwaeri/md5-js';

// npm install --save @kwaeri/developer-tools
import { kdt } from '@kwaeri/node-kit/node-kit/core/kdt';

import debug from 'debug';

// DEFINES
const _ = new kdt()
      DEBUG = debug( 'nodekit:server' ),;

You'll need to prepare a configuration for the server component. In the node-kit entry, this is done through a standardized configuration file found in an application's conf directory.

You can use this configuration as an example. Please note that you'll only need the contents of the development or production properties found in the example. Furthermore, you do not need to have paths for both admin and app, the paths could be nested directly within the root of the object itself. You are free to structure your application as you wish, provided you update the configuration to reflect it properly, and structure the resulting configuration object appropriately.

You may also enhance this entry point so that it supports a full configuration such as that demonstrated in the official entry point.

After reading the configuration, you'll need to prepare (instantiate) each of the components, and bundle them into the configuration so that the application we're building with the server component has the facilities it needs for handling all of its processes. This process includes instantiating the many components, providing them their configurations, and ultimately preparing everything from paths, to a session provider and its store, data persistence, etc.

Next, it's time to build the server component:

...
const server = new Server( configuration );

Finally, you can start the server:

server.start();

Of course, you'll need to provide the application structure to support the now running application, and make use of its dynamic routing capabilities. Documentation specific to this will be included at some point in the future. However, and again - kwaeri/node-kit serves as a perfect example of this.

More to come!

NOTE:

This information will be revisited as the platform nears an official initial release.

How to Contribute Code

Our Open Source projects are always open to contribution. If you'd like to cocntribute, all we ask is that you follow the guidelines for contributions, which can be found at the Massively Modified Wiki

There you'll find topics such as the guidelines for contributions; step-by-step walk-throughs for getting set up, Coding Standards, CSS Naming Conventions, and more.

The project also leverages Keybase for communication and alerts - outside of standard email. To join our keybase chat, run the following from terminal (assuming you have keybase installed and running):

keybase team request-access kwaeri

Alternatively, you could search for the team in the GUI application and request access from there.

Other Ways to Contribute

There are other ways to contribute to the project other than with code. Consider testing the software, or in case you've found an Bug - please report it. You can also support the project monetarly through donations via PayPal.

Regardless of how you'd like to contribute, you can also find in-depth information for how to do so at the Massively Modified Wiki

Bug Reports

To submit bug reports, request enhancements, and/or new features - please make use of the issues system baked-in to our source control project space at Gitlab

You may optionally start an issue, track, and manage it via email by sending an email to our project's support desk.

For more in-depth documentation on the process of submitting bug reports, please visit the Massively Modified Wiki on Bug Reports

Vulnerability Reports

Our Vulnerability Reporting process is very similar to Gitlab's. In fact, you could say its a fork.

To submit vulnerability reports, please email our Security Group. We will try to acknowledge receipt of said vulnerability by the next business day, and to also provide regular updates about our progress. If you are curious about the status of your report feel free to email us again. If you wish to encrypt your disclosure email, like with gitlab - please email us to ask for our GPG Key.

Please refrain from requesting compensation for reporting vulnerabilities. We will publicly acknowledge your responsible disclosure, if you request us to do so. We will also try to make the confidential issue public after the vulnerability is announced.

You are not allowed, and will not be able, to search for vulnerabilities on Gitlab.com. As our software is open source, you may download a copy of the source and test against that.

Confidential Issues

When a vulnerability is discovered, we create a [confidential issue] to track it internally. Security patches will be pushed to private branches and eventually merged into a security branch. Security issues that are not vulnerabilites can be seen on our public issue tracker.

For more in-depth information regarding vulnerability reports, confidentiality, and our practices; Please visit the Massively Modified Wiki on Vulnerability

Donations

If you cannot contribute time or energy to neither the code base, documentation, nor community support; please consider making a monetary contribution which is extremely useful for maintaining the Massively Modified network and all the goodies offered free to the public.