https://github.com/harvestprofit/harvest-profit-api-core

https://github.com/harvestprofit/harvest-profit-api-core

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/harvestprofit/harvest-profit-api-core
• Owner: HarvestProfit
• License: mit
• Created: 2018-07-25T15:02:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-27T17:18:26.000Z (over 6 years ago)
• Last Synced: 2024-10-06T16:46:04.838Z (3 months ago)
• Language: JavaScript
• Homepage: https://harvestprofit.github.io/harvest-profit-api-core/
• Size: 10.9 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![CircleCI](https://circleci.com/gh/HarvestProfit/harvest-profit-api-core.svg?style=svg&circle-token=1b4aaf037d0fc472f191c6c6ed967319f7703ac7)](https://circleci.com/gh/HarvestProfit/harvest-profit-api-core)

[![codecov](https://codecov.io/gh/HarvestProfit/harvest-profit-api-core/branch/master/graph/badge.svg)](https://codecov.io/gh/HarvestProfit/harvest-profit-api-core)

## Installation

You can install this via [NPM](https://www.npmjs.com/):

```bash

npm install @harvest-profit/api-core

```

Or [Yarn](https://yarnpkg.com/en/):

```bash

yarn add @harvest-profit/api-core

```

## Usage

```js static

import ApiCore from 'harvest-profit/api-core';

```

## Development

While developing, you may find it useful to preview your components. You can do so by running the development server with:

```bash

yarn start

```

To deploy a new version to NPM, bump the version number, commit/merge to `master`, and run the following:

```bash

yarn run clean

yarn run build

# Either NPM

npm publish

# Or Yarn, they do the same thing

yarn publish

```

## License

This project is [MIT licensed](https://github.com/HarvestProfit/harvest-profit-api/blob/master/LICENSE)