https://github.com/tetcoinjs/common

Various useful utility functions that are used across all projects in the @tetcoin namespace.
https://github.com/tetcoinjs/common

crypto tutorials yarn

Last synced: 11 days ago
JSON representation

Various useful utility functions that are used across all projects in the @tetcoin namespace.

• Host: GitHub
• URL: https://github.com/tetcoinjs/common
• Owner: tetcoinjs
• License: apache-2.0
• Created: 2021-02-21T20:45:14.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-05-22T16:37:31.000Z (over 3 years ago)
• Last Synced: 2024-10-30T07:59:28.159Z (17 days ago)
• Topics: crypto, tutorials, yarn
• Language: TypeScript
• Homepage: https://js.tetcoin.org
• Size: 25.9 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![tetcoinjs](https://img.shields.io/badge/tetcoinjs-orange?logo=&style=flat-square)](https://js.tetcoin.org)

![license](https://img.shields.io/badge/License-Apache%202.0-blue?logo=apache&style=flat-square)

[![npm](https://img.shields.io/npm/v/@tetcoin/util?logo=npm&style=flat-square)](https://www.npmjs.com/package/@tetcoin/util)

[![beta](https://img.shields.io/npm/v/@tetcoin/util/beta?label=beta&logo=npm&style=flat-square)](https://www.npmjs.com/package/@tetcoin/util)

[![maintainability](https://img.shields.io/codeclimate/maintainability-percentage/tetcoinjs/common?logo=code-climate&style=flat-square)](https://codeclimate.com/github/tetcoinjs/common)

[![coverage](https://img.shields.io/codeclimate/coverage/tetcoinjs/common?logo=code-climate&style=flat-square)](https://codeclimate.com/github/tetcoinjs/common)

# @tetcoin/common

Various useful utility functions that are used across all projects in the [@tetcoin](https://js.tetcoin.org) namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.

## overview

This repository is split up into a number of internal packages, namely utilities -

- [keyring](packages/keyring/) Keyring management

- [util](packages/util/) General utilities

- [util-crypto](packages/util-crypto/) Crypto and hashing utilities

## development

Contributions are welcome!

To start off, this repo (along with others in the [@tetcoin](https://github.com/tetcoinjs/) family) uses yarn workspaces to organise the code. As such, after cloning, its dependencies _should_ be installed via `yarn`, not via npm; the latter will result in broken dependencies.

To get started -

1. Clone the repo locally, via `git clone https://github.com/tetcoinjs/common `

2. Ensure that you have a recent version of Node.js, for development purposes [Node 10](https://nodejs.org/en/) is recommended.

3. Ensure that you have a recent version of Yarn, for development purposes [Yarn >=1.10.1](https://yarnpkg.com/docs/install) is required.

4. Install the dependencies by running `yarn`

5. Build the everything via `yarn run build`

6. You can also launch the API Docs, via `yarn vuepress dev docs`

7. Access the docs via [http://localhost:8080](http://localhost:8080)

## tutorials

Looking for tutorials to get started? Look at [examples](https://js.tetcoin.org/api/examples/keyring/) for guides on how to use the base utilities.