Skip to content

Data structures and functionalities for the Nillion Network user identity and authorization framework.

License

Notifications You must be signed in to change notification settings

NillionNetwork/nuc-ts

Repository files navigation

nuc

A TypeScript library for working with Nillion's authentication system.

CI CD GitHub package.json version npm

Installation and Usage

The library can be imported in the usual ways:

import * as Nuc from '@nillion/nuc';

Development

This project is managed via pnpm. To install dependencies run:

pnpm install

Documentation

The documentation can be generated automatically from the source files using TypeDoc:

pnpm docs

Testing and Conventions

All unit tests are executed and their coverage is measured when using vitest:

pnpm test --coverage

Style conventions are enforced using Biome:

biome check

Contributions

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

The version number format for this library and the changes to the library associated with version number increments conform with Semantic Versioning 2.0.0.

Publishing

This library can be published as a package on npmjs via the GitHub Actions workflow.

License

This project is licensed under the MIT License.

About

Data structures and functionalities for the Nillion Network user identity and authorization framework.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5