Skip to content

Commit

Permalink
Merge branch 'main' into con-462-replace-superagent
Browse files Browse the repository at this point in the history
  • Loading branch information
arnoerpenbeck committed Oct 7, 2024
2 parents 75ce460 + 1cd41fa commit 1a72452
Show file tree
Hide file tree
Showing 29 changed files with 136 additions and 840 deletions.
1 change: 0 additions & 1 deletion .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ module.exports = {
rules: {
'@typescript-eslint/no-unused-vars': 'error',
'no-undef': 'error',
'no-console': 'error',
'no-const-assign': 'error',
},
env: {
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
20.17.0
20.18.0
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This is a JavaScript/TypeScript SDK for the [fulfillmenttools REST API](https://

## πŸ‘‰ Get started

The TypeScript SDK is fully open source and is available on [GitHub](https://github.com/fulfillmenttools/fulfillmenttools-sdk-typescript).
The **TypeScript SDK** is fully open source and is available on [GitHub](https://github.com/fulfillmenttools/fulfillmenttools-sdk-typescript).
The package is published on [npmjs.com](https://www.npmjs.com/package/@fulfillmenttools/fulfillmenttools-sdk-typescript).
It contains both an ESM and a CommonJS build, so you can use it in the browser and in the backend.
You can install it with the command below:
Expand All @@ -49,6 +49,9 @@ Learn how to set up and use the TypeScript SDK with our [tutorial](./TUTORIAL.md

The official fulfillmenttools API documentation can be found [here](https://docs.fulfillmenttools.com/api-docs/), and we also publish our [OpenAPI specification](https://fulfillmenttools.github.io/api-reference-ui/).

> [!NOTE]
> Currently, the SDK is still in _beta_ status. It does not provide access to all of the features of our API but we are continuously extending it and pushing out new versions. We hope you will find it easy to use and are looking forward to your feedback.
## πŸ‘¨β€πŸ’» Development

### πŸ‘‰ Requirements
Expand All @@ -58,28 +61,28 @@ The official fulfillmenttools API documentation can be found [here](https://docs
### πŸ›« Setup

```bash
$ nvm use
nvm use
```

### 🀸 Building

```bash
$ npm install
$ npm run build
npm install
npm run build
```

### πŸ•΅οΈ Running unit tests

When running unit tests the `.env.local` file will be used with dummy settings.

```bash
$ npm run test
npm run test
```

### πŸ•΅οΈβ€β™€οΈ Linting

```bash
$ npm run lint
npm run lint
```

## πŸ“œ License
Expand Down
Loading

0 comments on commit 1a72452

Please sign in to comment.