open-index/open-npm huggingface dataset:
npm package: @norsktest/documentor
Description: A Svelte component to create beautiful documentation websites.
Author: NorskTest
Latest version: 1.0.0

# Documentor

A Svelte component to create beautiful documentation websites.

---

## create-svelte

Everything you need to build a Svelte library, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).

Read more about creating a library [in the docs](https://kit.svelte.dev/docs/packaging).

### Creating a project

If you're seeing this, you've probably already done this step. Congrats!

```bash
# create a new project in the current directory
pnpm create svelte@latest

# create a new project in my-app
pnpm create svelte@latest my-app
```

### Developing

Once you've created a project and installed dependencies with `pnpm install` (or `ppnpm install` or `yarn`), start a development server:

```bash
pnpm dev

# or start the server and open the app in a new browser tab
pnpm dev--open
```

Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.

### Building

To build your library:

```bash
pnpm package
```

To create a production version of your showcase app:

```bash
pnpm build
```

You can preview the production build with `pnpm run preview`.

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.

### Publishing

Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `LICENSE` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)).

To publish your library to [npm](https://www.npmjs.com):

```bash
pnpm publish
```
npm package: @norskvideo/webrtc-client
Description: WHIP/WHEP/duplex WebRTC client for Norsk integration
Author: Nicholas Wolverson
Latest version: 0.2.0

# webrtc-client

A simple client wrapper to initiate WebRTC connections via WHIP, WHEP and the similar internal duplex protocol for Norsk.

In the case of WHIP and WHEP, this package is provided in case it might be useful, but does not aim to be a fully general solution -
there are other JS libraries supporting WHIP and WHEP, as well as non-browser alternatives. This implementation is tested
with Norsk and used for internal test pages.

In the case of the Norsk duplex protocol - which is ultimately very similar to WHIP and WHEP - this code should provide a suitable
integration point. In that case there are no real alternatives other than deriving your own implementation, or simply making separate
webrtc connections for ingest and egest.

## Usage

Create a client: 

```
let myClient = new WhepClient({url: "subscribe"});
```
or 
```
let myClient = new WhipClient({url: "publish"});
```
or
```
let myClient = new DuplexClient({url: "subscribe"});
```

Then start the client as required:

```
await myClient.start();
```

For WHEP and Duplex clients you can optionally provide a `container` element, to which an appropriate video element will be added, and also optionally set up for simulcast video:

```
new WhepClient({url: "subscribe", container: document.getElementById('container'), simulcastVideoCount: 3 });
```

Otherwise you will find the created `RTCPeerConnection` can be accessed and used as normal:
```
myClient.client.addEventListener('track', (event) => console.log(event));
```

## Alternatives

* [@eyevinn/wrtc-egress](https://www.npmjs.com/package/@eyevinn/wrtc-egress) - WHEP and WHPP egress
* [@eyevinn/webrtc-player](https://www.npmjs.com/package/@eyevinn/webrtc-player) - player supporting WHIP
* [@medooze/whip-whep-js](https://github.com/medooze/whip-whep-js) - WHIP and WHEP clients
* [Cloudflare](https://developers.cloudflare.com/stream/webrtc-beta/#supported-whip-and-whep-clients) provide sample client code
npm package: @nortasian/starter
Description: A Simple Node.js Express starter project
Author: Ahmed Swerky
Latest version: 1.0.8

# Nortasian | Express-Prisma Node.js Starter

A Simple Node.js Express starter project.

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/nortasian/starter/GitHub%20CI?style=for-the-badge)](https://github.com/nortasian/starter/actions/) [![Made with Node.js](https://img.shields.io/badge/Node.js->=16-blue?logo=node.js&logoColor=white&style=for-the-badge)](https://nodejs.org/en/) [![Made with Express js](https://img.shields.io/badge/Express.js->=4.18-blue?logo=express&logoColor=white&style=for-the-badge)](https://expressjs.com/) [![Made with Sequelize](https://img.shields.io/badge/Sequelize-%3E=6.25-blue?logo=sequelize&logoColor=white&style=for-the-badge)](https://sequelize.org/) [![Made with Prisma](https://img.shields.io/badge/Prisma-%3E=4.3-blue?logo=prisma&logoColor=white&style=for-the-badge)](https://www.prisma.io/) [![Made with TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=white&style=for-the-badge)](https://www.typescriptlang.org/) [![Made with Express js](https://img.shields.io/badge/Jest->=29-blue?logo=Jest&logoColor=white&style=for-the-badge)](https://jestjs.io/) [![LICENSE](https://img.shields.io/github/license/nortasian/starter?logoColor=blue&style=for-the-badge)](https://github.com/nortasian/starter/blob/main/LICENSE.md)

## Installation

```bash
  npx @nortasian/starter [project name] --o [sequelize OR prisma] --db [postgresql OR mysql] --ts

  cd [project name]

  yarn db:migrate
```

## Quick Start

```bash
  npx @nortasian/starter project --o sequelize --db postgresql --ts

  cd project

  yarn db:migrate
```

## 🚀 Run Locally

Run the project

```bash
  yarn dev
```

OR

```bash
  npm run dev
```

## 🍄 List of available commands

- ### Generate Migration

```bash
  yarn generate:migration [file name]
```

- ### Generate Seeder

```bash
  yarn generate:seeder [file name] -m [model name] --module [module name]
```

***i.e. generate a seeder file as user.seeder.ts for user module and use the user model.***

```bash
  yarn generate:seeder user -m user --module user
```

- ### Run Database Seeders (Generate fake data)

```bash
  yarn db:seed
```

- ### Run Database Migrations

```bash
  yarn db:migrate
```

- ### Undo Last Database Migrations

```bash
  yarn db:migrate:undo
```

- ### Reset Database Migrations

```bash
  yarn db:migrate:undo:all
```

## 🧪 Running Tests

To run tests, run the following command

```bash
  yarn test
```

OR

```bash
  npm run test
```

## Authors

- [@ahmdswerky](https://www.github.com/ahmdswerky)

## License

Nortasian is licensed under the [Apache License](https://github.com/nortasian/starter/blob/main/LICENSE.md), Version 2.0. See [LICENSE](https://github.com/nortasian/starter/blob/main/LICENSE.md) for the full license text.
npm package: @nortb/payments
Description: Made with create-react-library
Author: nortb
Latest version: 1.0.6

# @nortb/payments

> Made with create-react-library

[![NPM](https://img.shields.io/npm/v/@nortb/payments.svg)](https://www.npmjs.com/package/@nortb/payments) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save @nortb/payments
```

## Usage

```jsx
import React, { Component } from 'react'

import MyComponent from '@nortb/payments'
import '@nortb/payments/dist/index.css'

class Example extends Component {
  render() {
    return <MyComponent />
  }
}
```

## License

MIT © [nortb](https://github.com/nortb)
npm package: @nortech/multi-aws-credentials
Description: For use cases where aws cli profiles are not sufficient
Author: joao@nortech.ai
Latest version: 2.11.0

## Multi aws credentials

Simple tool to manage multiple aws credentials locally for when aws cli profiles are not enough.

Supports password encryption, and receiving values from stdin to prevent shell history leakage.

As a preferred mode of operation, it loads your credentials into your shell env instead, meaning there are no unencrypted credential files on disk.

## Installation

- npm: npm install -g @nortech/multi-aws-credentials
- yarn: yarn global add @nortech/multi-aws-credentials

## Usage:

```
Usage: multi-aws-credentials [options] [command]

For use cases where aws cli profiles are not sufficient

Options:
  -V, --version                                   output the version number
  -h, --help                                      display help for command

Commands:
  add [options] <name> [id] [secret] [region]     Add a profile
  change <name>                                   Change the current (default) profile
  list                                            list profiles
  rename <current-name> <new-name>                Rename a profile
  upsert [options] <name> [id] [secret] [region]  Add a profile if it doesn't exist, otherwise replace it
  env <name>                                      Outputs a profile as shell compatible variable exports, for use with eval
  env-run <name> [script...]                      Run a command with configured environment variables. Pass command after -- or through stdin
  encrypt <name>                                  Encrypt a profile with a password
  remove <name>                                   Remove a profile
  help [command]                                  display help for command
```

## How it works

It creates a file in ~/.aws/$NAME.creds for each profile
Upon changing to a profile, it replaces ~/.aws/credentials with the specific profile file.
As a preferrable mode of operation, you should instead load the credentials into your current shell with the `env` command like `eval $(multi-aws-credentials env my-profile)`

## Why not cli profiles?

1. It makes the commands more verbose.
2. It makes scripts less reusable (every command needs to include an environment profile).
3. More prone to mistakes, if you forget to specify a profile somewhere in your script you might break something in the wrong aws environment.
4. Doesn't play well with non-cli tools. When using automated tools (such as terraform in nortech's case), they should not have to manage aws profiles.
npm package: @nortech/reqenv
Description: Require environment variables from your npm scripts with a self evident error message
Author: joao@nortech.ai
Latest version: 1.6.0

# Reqenv

```
Usage: reqenv <variables...>

Require environment variables from your npm scripts with a self evident error message

Arguments:
  variables      What variables you want to check e.g AWS_KEY WORKSPACE

Options:
  -V, --version  output the version number
  -h, --help     display help for command
```
npm package: @nortech/smell-test
Description: Runs a cli command and waits on a specific log
Author: joao@nortech.ai
Latest version: 1.8.0

# Smell test

```
Usage: smell-test [options] <log-line> <command...>

Runs a cli command and waits on a specific log line to appear

Options:
  -V, --version  output the version number
  -h, --help     display help for command
```
npm package: @north-tec/dingx-iot-cli
Description: dingx-iot-cli =============
Author: Klaus Eggers
Latest version: 1.0.2

dingx-iot-cli
=============



[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/dingx-iot-cli.svg)](https://npmjs.org/package/dingx-iot-cli)
[![Downloads/week](https://img.shields.io/npm/dw/dingx-iot-cli.svg)](https://npmjs.org/package/dingx-iot-cli)
[![License](https://img.shields.io/npm/l/dingx-iot-cli.svg)](https://github.com///blob/master/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @north-tec/dingx-iot-cli
$ dingx-iot COMMAND
running command...
$ dingx-iot (-v|--version|version)
@north-tec/dingx-iot-cli/1.0.2 win32-x64 node-v14.16.0
$ dingx-iot --help [COMMAND]
USAGE
  $ dingx-iot COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`dingx-iot convert [FILE]`](#dingx-iot-convert-file)
* [`dingx-iot help [COMMAND]`](#dingx-iot-help-command)

## `dingx-iot convert [FILE]`

convert OpcuaReadVars.csv to vars.json

```
USAGE
  $ dingx-iot convert [FILE]

OPTIONS
  -d, --destination=destination  export path
  -h, --help                     show CLI help

EXAMPLES
  $ dingx-iot convert .
  $ dingx-iot convert -d ./export .
```

_See code: [src/commands/convert.ts](https://gitlab.com/Shingazu/dingx-iot-cli/blob/v1.0.2/src/commands/convert.ts)_

## `dingx-iot help [COMMAND]`

display help for dingx-iot

```
USAGE
  $ dingx-iot help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_
<!-- commandsstop -->
npm package: @north-tec/epex-api
Description: API for epexspot
Author: Klaus Eggers
Latest version: 2.1.2

# EPEX API

[![npm version](https://img.shields.io/npm/v/@north-tec/epex-api.svg?style=flat-square)](https://www.npmjs.org/package/@north-tec/epex-api)
[![npm downloads](https://img.shields.io/npm/dm/@north-tec/epex-api.svg?style=flat-square)](http://npm-stat.com/charts.html?package=@north-tec/epex-api)
[![install size](https://packagephobia.now.sh/badge?p=@north-tec/epex-api)](https://packagephobia.now.sh/result?p=@north-tec/epex-api)
[![pipeline status](https://git.dingx.net/powerpro/repositories/epexspot-interface/badges/master/pipeline.svg)](http://git.dingx.net/powerpro/repositories/epexspot-interface/-/commits/master)
[![coverage report](https://git.dingx.net/powerpro/repositories/epexspot-interface/badges/master/coverage.svg)](http://git.dingx.net/powerpro/repositories/epexspot-interface/-/commits/master)

## Installing

Using npm:

```cmd
$ npm install @north-tec/epex-api
```

## Example

```javascript
const epexApi = require('@north-tec/epex-api').epex;

epexApi.parse('2018-07-01', 'FR').then(auctions => {
    console.log(auctions);
}).catch(err => {
    console.log(err);
});
```

```typescript
import { epex } from '@north-tec/epex-api';

epex.parse('2018-07-01', 'FR').then(auctions => {
    console.log(auctions);
}).catch(err => {
    console.log(err);
});
```

<a name="Epex"></a>

## Epex
<p>Create a new instance of Epex</p>

**Kind**: global class  

* [Epex](#Epex)
    * [.dateFormat](#Epex+dateFormat) : <code>string</code>
    * [.baseUrl](#Epex+baseUrl) : <code>string</code>
    * [.parse(date, country)](#Epex+parse) ⇒ <code>Promise</code>

<a name="Epex+dateFormat"></a>

### epex.dateFormat : <code>string</code>
**Kind**: instance property of [<code>Epex</code>](#Epex)  
<a name="Epex+baseUrl"></a>

### epex.baseUrl : <code>string</code>
**Kind**: instance property of [<code>Epex</code>](#Epex)  
<a name="Epex+parse"></a>

### epex.parse(date, country) ⇒ <code>Promise</code>
<p>Parse the dayahead auctions from epexspot</p>

**Kind**: instance method of [<code>Epex</code>](#Epex)  
**Returns**: <code>Promise</code> - <p>Resolves the auctions as array</p>  
**Fulfil**: <code>Array</code>    -     The auctions as an array  
**Reject**: <code>Error</code>    -     An error  

| Param | Type | Description |
| --- | --- | --- |
| date | <code>String</code> | <p>The date of the auctions in the given dateFormat</p> |
| country | <code>String</code> | <p>The country short</p> |


## Resources

* [Changelog](https://git.dingx.net/powerpro/repositories/epexspot-interface/blob/master/CHANGELOG.md)

## License

MIT
npm package: @north7/terraformaware
Description: MCP server for querying Terraform Registry API and interacting with Terraform providers
Author: North7
Latest version: 0.0.2
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# TerraformAware MCP Server

An MCP server for querying the Terraform Registry API and interacting with Terraform providers, specifically focused on AzureRM and AzureAD providers.

## Features

- Query the Terraform Registry API for provider information
- Get detailed information about AzureRM provider resources and data sources
- Get detailed information about AzureAD provider resources and data sources
- Retrieve examples for resources and data sources

## Installation

```bash
npm install -g @north7/terraformaware
```

## Usage

This package is designed to be used as an MCP server with compatible clients like Claude. The server exposes the following tools:

### askTerraform

General purpose tool for querying the Terraform Registry API.

### askAzureRM

Focused tool for querying information about the AzureRM provider.

### askAzureAD

Focused tool for querying information about the AzureAD provider.

## Development

To build the project:

```bash
npm run build
```

To start the server:

```bash
npm start
```

## License

MIT
npm package: @northbrook/buba
Description: Build your northbrook projects with Buba
Author: Tylor Steinberger
Latest version: 1.0.0

# @northbrook/buba

> Build your ES2015+ projects with Buba :heart:

Transpile your ES2015+ code into ES5 with [Buba](https://github.com/davidchase/buba).

For ease of setup, your `.js` files *must* be located inside of a directory named
`src` at the root of your packages.

## Let me have it
```sh
npm install --save @northbrook/buba
# or
yarn add @northbrook/buba
```

## Configuration

```js
// northbrook.js
const buba = require('@northbrook/buba').plugin

module.exports = {
  plugins: [
    buba,
  ],

  // 100% optional
  buba: {
    // Please see the buba documentation for more information on
    // what options are available :)
    bubleOptions: { ... },
    babelOptions: { ... }
  }
}
```
npm package: @northbrook/commit-types
Description: Commit types for northbrook :)
Author: Tylor Steinberger
Latest version: 1.1.0

# @northbrook/commit-types

Commit types used by [northbrook](https://gitub.com/TylorS/northbrook)

Can be used easily with [validate-commit-msg](https://github.com/kentcdodds/validate-commit-msg)

```js
// package.json
{
  "config": {
    "ghooks": {
      "commit-msg": "node ./node_modules/.bin/validate-commit-msg"
    },
    "validate-commit-msg": {
      "types": "@northbrook/commit-types"
    }
  }
}
```
npm package: @northbrook/eslint
Description: Northbrook Plugin for ESlint
Author: Tylor Steinberger
Latest version: 2.0.1

# Northbrook ESLint

> Lint your projects with ESLint

# Installation

```sh
npm install --save-dev @northbrook/eslint
```

**northbrook.js**
```js
const eslint = require('@northbrook/eslint').plugin

module.exports = {
  plugins: [ eslint ]
}
```

# API and configurations

**`northbrook eslint`**

Run ESLint on all of your source code files. Will look for a
`.eslintrc` at the root of your northbrook project, but will fallback
to using `eslint-config-standard`.

### Options

Inside of your `northbrook.js`

```js
{
  // all 100% optional
  eslint: {
    // default : ['src/']
    "directories": ["lib/**/*.js"], // paths to lint - supports globs
    // default: 'stylish'
    "formatter": "table" // allows you to specify
  }
}
```
npm package: @northbrook/mocha
Description: Mocha Configuration for Northbrook
Author: Tylor Steinberger
Latest version: 3.1.1

# @northbrook/mocha

> Test your packages with Mocha

Seamless testing with Mocha for Northbrook.
Handles TypeScript and ES2015 tests out-of-box.

Requires test files to be named using one of the following patterns:

- `.test.(js|ts)`
- `.spec.(js|ts)`,
- `-test.(js|ts)`,
- `-spec.(js|ts)`
- `Test.(js|ts)`,
- `Spec.(js|ts)`

## Let me have it!
```sh
npm install --save-dev @northbrook/mocha
```

## Usage

### Configuration

```typescript
// northbrook.js
const mocha = require('@northbrook/mocha').plugin;
// northbrook.ts
import { plugin as mocha } from '@nothrbook/mocha';

module.exports = {
  plugins: [ mocha ],

  // 100% optional
  mocha: {
    // An array of packages to require before running your tests
    // That would normally be used as `mocha -r _____`
    require: [ 'jsdom-global/register' ],
    // An array of packages you would like to be excluded from test running
    exclude: [ 'name-of-package' ]
  }
}
```

### CLI

```sh
northbrook mocha
```

#### CLI Options

##### **--changed**

Only run tests for the packages that have changed since last release.
This option is very useful for speeding up CI testing for monorepos.

```sh
northbrook mocha --changed
```

##### **--require**

A list of packages, separated by comma, to require before running your tests
That would normally be used as `mocha -r _____`

```sh
northbrook mocha --require jsdom-global/register,buba/register
```
npm package: @northbrook/preset-ts-mocha
Description: Northbrook preset for TypeScript and Mocha
Author: Tylor Steinberger
Latest version: 1.2.1

# Northbrook TypeScript Mocha Preset

All your TypeScript and Mocha plugins in one conveninent place!

Contains the following plugins

- @northbrook/ts-build
- @northbrook/ts-create
- @northbrook/ts-init
- @northbrook/tslint
- @northbrook/ts-mocha

## Get it

```
npm install -D @northbrook/preset-ts-mocha
```

## Use it

```
{
  "packages": [],
  "plugins": [
    "preset-ts-mocha"
  ]
}
```
npm package: @northbrook/rollup
Description: Rollup your Northbrook packages
Author: Tylor Steinberger
Latest version: 1.0.1

# @northbrook/rollup

> Rollup your Northbrook packages

A simple [Northbrook](https://github.com/northbrookjs/northbrook) plugin for 
running rollup in your packages. It works by looking for a `rollup.config.js`
in each package directory, and calls `rollup -c` for you. 

If a package does not have a `rollup.config.js` it will simply be skipped over 
assuming that it does not need a build system. 

## Let me have it 

```sh
npm install --save-dev @northbrook/rollup
# or 
yarn add --dev @northbrook/rollup 
```

## Cofiguration 
```js
//northbrook.js 

module.exports = {
  plugins: [
    'rollup'
  ]
}

```
npm package: @northbrook/ts-build
Description: Northbrook plugin to build with tsc
Author: Tylor Steinberger
Latest version: 1.2.0

# Northbrook TypeScript build

Builds all managed packages with `tsc`. Configurable via `tsconfig.json`.
It will first look within the package directory, and then the top-level next to
your `northbrook.json`.

## Get it

```sh
npm install --save-dev @northbrook/ts-build
```

And in your `northbrook.json`

```json
{
  "plugins": [
    "northbrook-ts-build"
  ]
}
```

## Usage

```sh
northbrook ts-build
```
npm package: @northbrook/ts-create
Description: Create Northbrook managed packages with TS + Mocha + TSLint.
Author: Tylor Steinberger
Latest version: 1.4.0

# Northbrook Typescript Create Plugin

> Create managed projects that use typescript

Designed to work out-of-the-box with ts-init, ts-mocha, ts-tsc, and ts-tslint.

## Installation

```sh
npm install --save-dev @northbrook/ts-create
```

add me to your northbrook.json

```json
{
  "plugins": [
    "northbrook-ts-create"
  ]
}
```

# API

### **northbrook ts-create [relativePathToPackage]**

Scaffolds and sets up a new managed package. Generates a folder named at
`relativePathToPackage` and generates the following files inside after prompting
for a questions to better initialize the package.

- package.json
- README.md
- src/index.ts
- test/index.ts
npm package: @northbrook/ts-init
Description: Initialize a Northbrook monorepo for use with TS + Mocha + TSLint
Author: Tylor Steinberger
Latest version: 0.4.1

# Northbrook TypeScript Init

> Initialize a TypeScript package

This package helps setup a new package which is designed to be managed with TypeScript.

# Get it

```sh
npm install --save-dev @northbrook/ts-init
```

# Use it

```sh
northbrook ts-init
```
npm package: @northbrook/ts-mocha
Description: Northbrook plugin for testing with ts-node + mocha
Author: Tylor Steinberger
Latest version: 1.5.2

# Northbrook TypeScript Mocha

> Test your packages with mocha + ts-node

# Get it

```sh
npm install --save-dev @northbrook/ts-mocha
```

# Configure it

```js
// northbrook.json
{
  "plugins": [
    "ts-mocha" // add to registered plugins
  ],
  // optional configuration
  "ts-mocha": {
    // default : []
    exclude: ["somePackage"] // exclude a managed package from testing
    // default: 'test/'
    directory: "src/" a place to find your test,
    // default: ['.ts', '.tsx']
    extensions: ['.spec.ts'] // extensions to match
  }
}

// tsconfig.json - TypeScript 2.x
{
  "compilerOptions": {
    ...
    "types": [
      "node",
      "mocha"
    ]
  }
}
```

# Use it

```sh
northbrook ts-mocha
# only run for a specific package
northbrook ts-mocha --only somePackage
```
npm package: @northbrook/util
Description: Utility functions for Northbrook
Author: Tylor Steinberger &lt;tlsteinberger167@gmail.com&gt;
Latest version: 1.0.3

# @northbrook/util

> Utilities for Northbrook (or any node.js application)

# Get it

```sh
npm install @northbrook/util
```

# Documentation

Head over [here](https://northbrookjs.github.io/northbrookjs/doc/util.html)
npm package: @northcoders-dev-team/dorris-design
Description: >
Author: jackethdavies
Latest version: 3.6.0

# Dorris Design

## Installation

After you have been added to the `@northcoders-dev-team` organisation on npm, then you can use the following command to install the package:

`npm i @northcoders-dev-team/dorris-design`

## Usage Instructions

### Importing

```js
import {
    Component,
    ...
} from "@northcoders-dev-team/dorris-design";
```

## Using Components

```js
function Component() {
    return (
        <Component>
            Content
        </Component>
    );  
}
```
npm package: @northdata/fomantic-ui
Description: This is a modified package based on `fomantic-ui` which is a fork of `semantic-ui`.
Latest version: 2.9.416

# fomantic-ui

## Overview

This is a modified package based on `fomantic-ui` which is a fork of `semantic-ui`.

> Fomantic was created to continue active development of Semantic-UI and has the intent to be merged back into the master repository once active development can restart.

- https://github.com/fomantic/Fomantic-UI
- https://fomantic-ui.com/

Some of the sources from the original distribution have been modified to fit the North Data application.

## Building and publishing

### Manual build

```console
npm install
npm run build
```

### CI / CD build

A CI build runs on every git push.

To publish a new package to npm use the following:

```console
npm version patch # bumps version package.json and creates a git tag
git push --follow-tags
```

A GitHub Action will be triggered that builds and publishes the new npm package.

### Naming and versioning

This package is named `@northdata/fomantic-ui`. The version is derived from the version of the original `fomantic-ui` package, multiplying the patch version by 100 and incrementing it for each release build of this modified distribution.

Thus, the baseline version `fomantic-ui@2.8.6` corresponds to a sequence of custom releases `@northdata/fomantic-ui@2.6.600`, `@northdata/fomantic-ui@2.6.601` and so on.