@kwaeri/router
Version:
The @kwaeri/router component of the @kwaer/node-kit application platform.
122 lines (71 loc) • 9.2 kB
Markdown
# [](https://patreon.com/kirvedx) kwaeri-node-kit-router [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YUW4CWCAABCU2)
A Massively Modified Open Source Project by kirvedx
[](https://keybase.io/rik)
[](https://developers.google.com/profile/u/117028112450485835638)
[](https://github.com/kirvedx)
[](https://github.com/kirvedx)
[](https://npmjs.com/~rik)
The kwaeri/router component for the kwaeri/node-kit application platform
[](https://gitlab.com/kwaeri/node-kit/router/commits/main) [](https://kwaeri.gitlab.io/node-kit/router/coverage/) [](https://bestpractices.coreinfrastructure.org/projects/1879)
## TOC
* [The Implementation](#the-implementation)
* [Getting Started](#getting-started)
* [Installation](#installation)
* [Usage](#usage)
* [How to Contribute Code](#how-to-contribute-code)
* [Other Ways to Contribute](#other-ways-to-contribute)
* [Bug Reports](#bug-reports)
* [Vulnerability Reports](#vulnerability-reports)
* [Confidential Issues](#confidential-issues)
* [Donations](#donations)
## The Implementation
kwaeri/router reinvents and modernizes the router portion of the kwaeri/node-kit application platform.
As the router component was originally baked into the nodekit module, its usage was entirely governed by it. As we discern the process for decoupling the individual components which make up a kwaeri/node-kit 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](https://www.npmjs.com/package/@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](https://www.npmjs.com/package/@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/router and utilize it specifically - perform the following steps to get started:
Install kwaeri/router:
```bash
npm install @kwaeri/router
```
### Usage
We have not discerned the entire process one will need to follow in order to make use of kwaeri/router individually. The component was originally intended to be used in conjunction with several other components which make up the nodekit application platform.
As we discern the process for doing so, this section will be expanded.
To leverage the router component module, you'll first need to include it:
```javascript
// INCLUDES
import { Router } from '@kwaeri/router';
```
**NOTE**
As mentioned earlier, the plan is to continue development of the individual components of a kwaeri application - the router component included - and ultimately ease the process of making use of each individual component as they are decoupled from one another.
More documentation to come!
## 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](https://gitlab.com/mmod/documentation/wikis/Contribute-to-Massively-Modified/Contribute-Code)
There you'll find topics such as the guidelines for contributions; step-by-step walk-throughs for getting set up, [Coding Standards](https://gitlab.com/mmod/documentation/wikis/Contribute-to-Massively-Modified/Coding-Standards), [CSS Naming Conventions](https://gitlab.com/mmod/documentation/wikis/Contribute-to-Massively-Modified/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](https://www.keybase.io) installed and running):
```bash
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](https://gitlab.com/mmod/documentation/wikis/Contribute-to-Massively-Modified/Test-Code) the software, or in case you've found an [Bug](https://gitlab.com/mmod/documentation/wikis/Other-Ways-to-Contribute/Bug-Reports) - please report it. You can also support the project monetarly through [donations](https://gitlab.com/mmod/documentation/wikis/Contribute-to-Massively-Modified/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](https://gitlab.com/mmod/documentation/wikis/Other-Ways-to-Contribute)
### 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](https://gitlab.com/mmod/kwaeri-node-kit/issues)
You may optionally start an issue, track, and manage it via email by sending an email to our project's [support desk](mailto:contact-project+kwaeri-node-kit-router-8006502-issue-@incoming.gitlab.comm).
For more in-depth documentation on the process of submitting bug reports, please visit the [Massively Modified Wiki on Bug Reports](https://gitlab.com/mmod/documentation/wikis/Other-Ways-to-Contribute/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](mailto:security@mmod.co). 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](https://gitlab.com/mmod/kwaeri-node-kit/issues?label_name%5B%5D=Security).
For more in-depth information regarding vulnerability reports, confidentiality, and our practices; Please visit the [Massively Modified Wiki on Vulnerability](https://gitlab.com/mmod/documentation/wikis/Other-Ways-to-Contribute/Vulnerability-Reports)
### 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.
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YUW4CWCAABCU2)