Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pabloibanezcom/autonomo.common

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/pabloibanezcom/autonomo.common
Owner: pabloibanezcom
Created: 2021-11-08T11:44:52.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2022-11-09T19:22:31.000Z (about 2 years ago)
Last Synced: 2023-03-02T23:50:58.059Z (almost 2 years ago)
Language: TypeScript
Size: 315 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # autonomo.common

[![npm version](https://img.shields.io/npm/v/@autonomo/common.svg?style=flat-square)](https://www.npmjs.com/package/@autonomo/common)

[![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=@autonomo/common&query=$.install.pretty&label=install%20size&style=flat-square)](https://packagephobia.now.sh/result?p=@autonomo/common)

[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@autonomo/common?style=flat-square)](https://bundlephobia.com/package/@autonomo/common@latest)

[![Known Vulnerabilities](https://snyk.io/test/npm/@autonomo/common/badge.svg)](https://snyk.io/test/npm/@autonomo/common)

A library that contains all needed common resources to be used in [autonomo.api](https://github.com/pabloibanezcom/autonomo.api) and [autonomo.web](https://github.com/pabloibanezcom/autonomo.web) repositories.

## Table of Contents

- [Installing](#installing)

- [Running in development mode](#running-in-development-mode)

- [Building](#building)

- [Testing](#testing)

- [Publishing](#publishing)

- [Example of use in other client repo](#example-of-use-in-other-client-repo)

## Installing

```bash

npm install

```

## Running in development mode

```bash

npm run dev

```

This will build the package and will watch for any change to re-build it.

## Building

```bash

npm run build

```

## Testing

```bash

# running tests once

npm run test

# running tests on every change on code

npm run test:watch

# running tests and getting coverage report

npm run test:coverage

```

## Publishing

```bash

npm run publish:patch

```

A npm user must be configured in order to be able to publish it.

## Example of use in other client repo

Install first autonomo.common in the repo

```bash

npm install @autonomo.common

```

Then you need to import the resource (interface, type, enum, util, ...) from root package

```js

import { Business } from '@autonomo/common';

const business: Business = {

  key: 'myBusiness',

  name: 'My business',

  ...

}

```