Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/content/2.frontier/1.introduction/1.whats-frontier.md
Comment thread
apeart-rd marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# What is Frontier?

[Frontier](https://github.com/realdecoy/frontier/) is a universal and extensible development toolchain established to expedite product development, management, and post deployment application support. It brings our current domain-level tools under one large umbrella giving the ability to scaffold backend, web, QA, mobile and other application tools.

It offers a set of standard libraries and typing kits that can be used across engineering projects to allow for more consistent software development. With frontier, a set of plugins are available for use by developers which can be used to easily generate base project files contributing to a faster development process.
24 changes: 24 additions & 0 deletions docs/content/2.frontier/1.introduction/2.content-directory.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,26 @@
# Content directory

## Structure


```
- Templates
- Addon
- Library
- Examples
- Project Playground A..
- Admin Dashboard Example
- Packages
- Frontier-core
- lib-builder
- cli
- Frontier-plugins
- plugin-vue
- plugin-mobile
- plugin-qa
- Frontier-libraries
- stdlib
- typekit
- Docs
- Tests
```
1 change: 1 addition & 0 deletions docs/content/2.frontier/2.installation/1.general.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# General Use

When using the frontier cli tool it is preferred that when running commands yarn is used over npm. When npm is used some frontier's mono repository features may not work as they should therefore yarn is needed. Using yarn also allows for parallel installation of the frontier tool to take place.
50 changes: 50 additions & 0 deletions docs/content/2.frontier/3.cli/1.usage.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,52 @@
# Usage

Installing the CLI can be done with the following commands:

```bash
$ npm install -g @rdfrontier/cli
```

or

```bash
$ yarn global add @rdfrontier/cli
```

## Check Commands

```bash
$ npm install -g @rdfrontier/cli
```

## Options

```txt
Usage:
frontier <action>

Commands:
plugins - List installed plugins
plugins:install - Install plugins

Options:
--help | -h - Show help information
--version | -v - Show current version

```

## Help Menu

The help menu can be accessed with the command:
```bash
$ frontier --help
```


## Check Version

The current version of rdvue can be retrieved with the command:

```bash
$ frontier -v|--version|version
```

27 changes: 27 additions & 0 deletions docs/content/2.frontier/4.plugins/1.frontend.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# Frontend

## [RDVue CLI Plugin](http://frontier.realdecoy.com/rdvue/getting-started/overview)

Derived from the product of RealDecoy's Frontend Practice group it allows for easy generation of Vue.js projects, by employing, a development style guide which enforces:

- Strong typing with TypeScript
- Standardized Component
- Layout and Page models
- A data-layer design promoting unified consumption through Stores and Services



## Options

```txt
frontier vue:<action>:<feature>

Actions:
create-project - Scaffold a new rdvue project
add - Add a feature to a project
plugin - Inject a utility to extend project functionality
upgrade - Specify the rdvue template version for a project

Options:
--help | -h - Show help information

```

25 changes: 25 additions & 0 deletions docs/content/2.frontier/4.plugins/2.mobile.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# Mobile

## [RDVue Mobile CLI Plugin](http://frontier.realdecoy.com/mobile/getting-started/overview)

A product of RealDecoy's Frontend Mobile Practice Area, allows for easy generation of React Native projects, by employing a development style guide which enforces:
- Strong typing with TypeScript
- Standardized Component
- Layout and Screen models
- A data-layer design promoting unified consumption through React Contexts and Services



## Options

```
Usage:
npx mobile <action>

Actions:
create-project - Scaffold a new mobile project
add - Add a feature to a project
plugin - Inject a utility to extend project functionality

Options:
--help | -h - Show help information
--verbose - Show debug logs to get more information
```
158 changes: 157 additions & 1 deletion docs/content/2.frontier/5.libraries/1.typekit.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,158 @@
# TypeKit
# Frontier TypeKit Library

## @rdfrontier/typekit

A library of common reusable types.



## Table of Contents

***

- Installation
- Usage
- Options


## Installation

```
$ yarn add --save--dev @rdfrontier/typekit
```

or

```
$ npm install --save--dev @rdfrontier/typekit
```

## Usage

```
import { SuccessCode } from '@rdfrontier/typekit';

console.log(SuccessCode.Countinue)
```

## Options

| Name | Description |
| ----------------------|------------------|
| HTTP Status Codes | Add Description |
| Network Information | Add Description |


## HTTP Status Codes

This is ______________

## Information Code

```
Continue - 100
SwitchingProtoclos - 101
Processing - 102
EarlyHints - 103
```

## Success Code

```
OK - 200
Created - 201
Acccepted - 202
NoAuthoritativeInformations - 203
NoConent - 204
ResetConent - 205
PartialConent - 206
MultiStatus - 207
AlreadyReported - 208
IMUsed - 226
```

## Redirect Code

```
MultipleChoices - 300
MovedPermanently - 301
Found - 302
SeeOther - 303
NotModified - 304
TemporaryRedirect - 307
PermanentRedirect - 308
```

## Client Error Code

```
BadRequest - 400
Unauthorized - 401
PaymentRequired - 402
Forbidden - 403
NotFound - 404
MethodNotAllowed - 405
NotAcceptable - 406
ProxyAuthenticationRequired - 407
RequestTimeout - 408
Conflict - 409
Gone - 410
LengthRequired - 411
PreconditionFailed - 412
PayloadTooLarge - 413
URITooLong - 414
UnsupportedMediaType - 415
RangeNotSatisifiable - 416
ExpectationFailed - 417
ImATeapot - 418
MisdirectedRequest - 421
UnprocessableEntity - 422
Locked - 423
FailedDependency - 424
UpgradeRequired - 426
PreconditionRequired - 428
ToomanyRequests - 429
RequestHeaderFieldsTooLong - 431
UnavailableForLegalReasins - 451
```

## Server Error Code

```
InternalServerError - 500
NotImplemented - 501
BadGateway - 502
ServiceUnavailable - 503
GatewayTimeout - 504
HTTPVersionNotSupported - 505
VariantAlsoNegotiates - 506
InusufficientStorage - 507
LoopDetected - 508
NotExtended - 510
NetworkAuthenticationRequired - 511
```

## Network Info

### Effective Connection Type

```
FouthGeneration - 4g
SecondGeneration - 2g
SlowSecondGeneration - slow-2g
ThirdGeneration - 3g
```

## Connection Type

```
Bluetooth - bluetooth
Cellular - cellular
Ethernet - ethernet
None - none
Other - other
Unknown - unknown
WiFI - wifi
WiMax - wimax
```

57 changes: 56 additions & 1 deletion docs/content/2.frontier/5.libraries/2.standard-library.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,57 @@
# Standard Library
# Frontier Standard Library

## @rdfrontier/stdlib

A collection of functions/logic that are written in pure TypeScript with limited dependencies. These functions expose generic concepts available for use throughout different projects.



## Table of Contents

- Installation
- Usage
- Options


## Installation

```
$ yarn add --save--dev @rdfrontier/stdlib
```

or

```
$ npm install --save--dev @rdfrontier/stdlib
```

## Usage

```
$ import { log } from '@rdfrontier/stdlib';
```

## Options


|**Name** | **Description** |
|----------------------------------------|----------------------------------------------|
| **Type Guards** | |
| isBoolean(value: unknown) | Checks if value is a boolean. |
| isNumber(value: unknown) | Checks if value is a number. |
| isString(value: unknown) | Checks if value is a string. |
| isNumberArray(value: unknown) | Checks if value is a number array. |
| isStringArray(value: unknown) | Checks if value is a string array. |
| toStringArray(value: unknown[]) | Converts an array to a string array. |
| isJsonString(value: string) | Checks if a string value is a JSON string |
| **Case Conversions** | |
| toKebabCase(value: string) | Converts a string to a kebab case string. |
| toPascalCase(value: string) | Converts an string to a pascal case string. |
| **Email Validation** | |
| isValidEmail(email: string) | Checks if a string is a valid email address. |
| **Color Validation** | |
| isValidHex(text: string) | Checks if a string is a valid hex color. |
| **Standard Output** | |
| log(message: any = '', ...args: any) | Prints a message to the console. |
| **Object Setting** | |
| makeObjectReadOnly< T >(obj: T) | Make an object readonly. |
Loading