kwaeri-developer-tools

A Massively Modified Open Source Project by kirvedx

kwaeri-developer-tools (kdt) is a minimal set of tools for aiding rapid development of application logic. It is also a dependency of several components which make up the @kwaeri/platform.

WARNING! kdt is not ready for production yet. We have decided to publish early for testing purposes during development. You are free to check us out, but please note that this project is by no means complete, nor safe, and we DO NOT recommend using kwdt at this time. With that said, please feel free to check the library out and see where it's headed!

Table of Contents

• The Implementation (about kdt)
  • Developer Hype
• Using kdt
  • Installation
  • Integration
    • JavaScript
• How to Contribute Code
• Other Ways to Contribute
  • Bug Reports
  • Vulnerability Reports
    • Confidential Issues
  • Donations

The Implementation

The library provides potentially familiar methods; .type(), .isNumber(), isVisible(), .empty(), .extend(), .each(), .has(), .get(), .set(), and recently added - a mixin composer, similarly named .compose(). We may very well add more tools to the collection as we continue to grow the project, though we've found that these tools more than suffice in helping us to rapidly develop logic on the server-side of any Node.js application.

Browse documentation for more information, including API reference (still in development).

If you're looking for a similar type of tooling for the client/browser - take a peek at our web development tools.

Developers

This project makes use of TypeScript, and recently rid itself of babel, gulp, and istanbul in favor of a direct typescript, mocha, nyc approach that is implemented as a pure ESM module. If you require CommonJS stick with version 0.3.0; otherwise, track 0.4.0+ from here on out.

Using kdt

To use kdt in your own project/application, install the module via npm and include it in your application:.

Installation

You can obtain kdt a couple of different ways:

• Via npm with npm install @kwaeri/developer-tools in a terminal/command prompt.
• Via direct download in several available formats:
  • .zip
  • .tar.gz
  • .tar.bz2
  • .tar

With either option, after obtaining the source (and building the project with the latter option), the production files can be found within the dist subdirectory.

Integration

Include the module anywhere you wish to make use of kdt:

import { kdt } from '@kwaeri/developer-tools';

Source maps are provided, so feel free to use kdt in development.

Once you have loaded the module into your application, you must initialize it:

const _ = new kdt();

You're now set to make use of kdt in your project.

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 a Bug - please report it. You can also support the project monetarily 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.